Skip to content

Commit 17577ee

Browse files
committed
Update README.md
1 parent fe8c9ff commit 17577ee

File tree

1 file changed

+33
-0
lines changed

1 file changed

+33
-0
lines changed

README.md

+33
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,35 @@
11
# som
22
Self Organizing Map
3+
4+
# Pre-requisites
5+
## Setup rust
6+
To download Rustup and install Rust, run the following in your terminal, then follow the on-screen instructions.
7+
```
8+
$ curl https://sh.rustup.rs -sSf | sh
9+
```
10+
11+
12+
# Setting up the project
13+
Here are the instructions on how to setup the project.
14+
## Clone Project
15+
Clone the repository
16+
```
17+
$ git clone https://github.com/sumedhe/som.git
18+
$ cd som
19+
```
20+
21+
## Build
22+
Build the project
23+
```
24+
$ cargo build --release
25+
```
26+
## Build & Run program
27+
To start the program,
28+
```
29+
$ cargo run
30+
```
31+
## Run tests
32+
Unit tests
33+
```
34+
$ cargo test
35+
```

0 commit comments

Comments
 (0)