From 62d67c34806175e3a527c82c3a470f6e0cfa7955 Mon Sep 17 00:00:00 2001 From: Marcel Date: Fri, 2 Feb 2018 19:02:57 +0100 Subject: [PATCH] Make it a complete README --- README.md | 44 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 44 insertions(+) diff --git a/README.md b/README.md index d9b1b0d..974510d 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,47 @@ # Toy-Neural-Network-JS Neural Network JavaScript library for Coding Train tutorials + +## Getting Started + +TODO + +### Prerequisites + +You need to have the following installed: + +1. Nodejs +2. NPM +3. Install the NodeJS dependencies via the following command: + +``` +npm install +``` + +### Installing + +This Project doesn't require any additional Installing steps + +## Running the tests + +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" + +## Built With + +* [Nodejs](https://nodejs.org/) - The code language used +* [CircleCI](https://circleci.com/) - Automated Test Service +* [Jest](https://facebook.github.io/jest/) - Testing Framework used + +## Contributing + +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. + +## Versioning + +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). + +## Authors + +* **shiffman** - *Initial work* - [shiffman](https://github.com/shiffman) + +See also the list of [contributors](https://github.com/CodingTrain/Toy-Neural-Network-JS/contributors) who participated in this project.