Skip to content
This repository was archived by the owner on Dec 11, 2019. It is now read-only.

Commit 208e579

Browse files
committed
Merge pull request #33 from NDari/wholeInstall
Enhance the base readme
2 parents e308db4 + 547840c commit 208e579

1 file changed

Lines changed: 22 additions & 3 deletions

File tree

README.md

Lines changed: 22 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,30 @@
11
# gocrunch
22

3-
gocrunch is a collection of libraries for numerical libraries in Go. Take a look at the packages below for more details about the specific libraries.
3+
gocrunch is a collection of libraries for numerical libraries in Go. Take a
4+
look at the packages below for more details about the specific libraries. If
5+
you wish to whole-sale install all the packages of gocrunch, then do:
6+
7+
```bash
8+
go get github.com/NDari/gocrunch/...
9+
```
10+
11+
Each library comes pre-packaged with all of its dependencies. Therefore it is
12+
strightforward to pick and choose which libraries you would like to use. For
13+
example, you may with to import and use only the `mat` package. You can get
14+
the package simply by:
15+
16+
```bash
17+
go get github.com/NDari/gocrunch/mat
18+
```
419

520
## Directories
621

7-
- [gocrunch/mat](https://github.com/NDari/gocrunch/tree/master/mat): Package mat implements functions that create or act upon `[][]float64`.
8-
- [gocrunch/vec](https://github.com/NDari/gocrunch/tree/master/vec): Package vec implements functions that act upon `[]float64`.
22+
- [gocrunch/vec](https://github.com/NDari/gocrunch/tree/master/vec): Package vec
23+
implements functions that act upon one dimentional slices of float64s, `[]float64`.
24+
A one dimentional slice can be thought of as a Vector.
25+
- [gocrunch/mat](https://github.com/NDari/gocrunch/tree/master/mat): Package mat
26+
implements functions that create or act upon two dimentional slices of float64s,
27+
`[][]float64`. A two dimentional slice can be thought of as a Matrix.
928

1029
## Badges
1130

0 commit comments

Comments
 (0)