Skip to content

Commit cf5243d

Browse files
authored
Merge pull request #1 from MTRNord/patch-1
Make the README more apealing and add more Information
2 parents a46fa1e + c4b0586 commit cf5243d

File tree

1 file changed

+44
-0
lines changed

1 file changed

+44
-0
lines changed

README.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,47 @@
11
# Toy-Neural-Network-JS
22

33
Neural Network JavaScript library for Coding Train tutorials
4+
5+
## Getting Started
6+
7+
TODO
8+
9+
### Prerequisites
10+
11+
You need to have the following installed:
12+
13+
1. Nodejs
14+
2. NPM
15+
3. Install the NodeJS dependencies via the following command:
16+
17+
```
18+
npm install
19+
```
20+
21+
### Installing
22+
23+
This Project doesn't require any additional Installing steps
24+
25+
## Running the tests
26+
27+
The Tests can either be checked via the automaticly running CircleCI Tests or you can also run `npm test` on your PC after you have done the Step "Prerequisites"
28+
29+
## Built With
30+
31+
* [Nodejs](https://nodejs.org/) - The code language used
32+
* [CircleCI](https://circleci.com/) - Automated Test Service
33+
* [Jest](https://facebook.github.io/jest/) - Testing Framework used
34+
35+
## Contributing
36+
37+
Please send PullRequests. These need to pass a automated Test first and after it will get reviewed and on that review either denied or accepted.
38+
39+
## Versioning
40+
41+
We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/CodingTrain/Toy-Neural-Network-JS/tags).
42+
43+
## Authors
44+
45+
* **shiffman** - *Initial work* - [shiffman](https://github.com/shiffman)
46+
47+
See also the list of [contributors](https://github.com/CodingTrain/Toy-Neural-Network-JS/contributors) who participated in this project.

0 commit comments

Comments
 (0)