Skip to content

Commit 780f3c9

Browse files
committed
add dependency libraries installation in README
1 parent e52b493 commit 780f3c9

File tree

1 file changed

+25
-11
lines changed

1 file changed

+25
-11
lines changed

README.md

+25-11
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,30 @@
1-
# numruby (nmatrix_reloaded)
2-
3-
Reimplementing NMatrix for fun
4-
5-
## NMatrix
1+
# NumRuby
62

73
[![Build Status](https://travis-ci.org/sciruby/numruby.svg?branch=master)](https://travis-ci.org/sciruby/numruby)
84

9-
Fast Numerical Linear Algebra Library for Ruby
5+
Fast Numerical Linear Algebra Library for Ruby. NMatrix reimplementation.
106

117
## Installation
128

9+
### Install dependency libraries
10+
11+
**Debian/Ubuntu**
12+
13+
```sh
14+
sudo apt-get install libopenblas-dev
15+
sudo apt-get install liblapack-dev
16+
sudo apt-get install liblapacke-dev
17+
```
18+
19+
**Mac OSX**
20+
21+
```sh
22+
brew install openblas
23+
brew install lapack
24+
```
25+
26+
### Build the library
27+
1328
```sh
1429
git clone https://github.com/sciruby/numruby
1530
cd numruby/
@@ -18,32 +33,31 @@ bundle install
1833
rake compile
1934
```
2035

21-
Run the tests using
36+
### Run tests
2237

2338
```sh
2439
rake test
2540
```
2641

27-
If you want to try out the code without installing:
42+
### Try out the code without installing
2843

2944
```sh
3045
rake pry
3146
```
3247

3348
## Speed Test
3449

35-
```
50+
```sh
3651
ruby benchmark/bench.rb
3752
```
3853

39-
4054
## Documentation
4155

4256
- http://www.rubydoc.info/github/prasunanand/nmatrix_reloaded
4357

4458
[Yard](https://www.rubydoc.info/gems/yard/) is used for documenting class and methods following yard [tags](https://www.rubydoc.info/gems/yard/file/docs/Tags.md). To generate the static documentation in doc folder run `yard doc`. To serve it in localhost run `yard server`.
4559

46-
# LICENSE
60+
## LICENSE
4761

4862
This software is distributed under the [BSD 3-Clause License](LICENSE).
4963

0 commit comments

Comments
 (0)