2martens
/
masterthesis
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Updated README with badges, links and some text 

Signed-off-by: Jim Martens <github@2martens.de>
This commit is contained in:
Jim Martens 2019-02-08 23:40:45 +01:00
parent 26904614cb
commit be4ee74537
1 changed files with 26 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

46
README.md
View File

@ -1,33 +1,36 @@
# Masterthesis # Masterthesis
> Short blurb about what your product does. > Short blurb about what your product does.
[![Downloads][pypi-downloads]][pypi-url]
![License][pypi-license]
![Python versions][pypi-python-versions]
One to two paragraph statement about your product and what it does. One to two paragraph statement about your product and what it does.
![](header.png) ![](header.png)
## Installation ## Installation
OS X & Linux:
```sh ```sh
npm install my-crazy-module --save pip install twomartens.masterthesis
``` ```
Windows: Please refer to [GPU support][tf-gpu-support] for instructions on
installing the non-Python dependencies for `tensorflow`.
```sh
edit autoexec.bat
```
## Usage example ## Usage example
A few motivating and useful examples of how your product can be used. Spice this up with code blocks and potentially more screenshots. A few motivating and useful examples of how your product can be used.
Spice this up with code blocks and potentially more screenshots.
_For more examples and usage, please refer to the [Wiki][wiki]._ _For more examples and usage, please refer to the [Wiki][wiki]._
## Development setup ## Development setup
Describe how to install all development dependencies and how to run an automated test-suite of some kind. Potentially do this for multiple platforms. **CHANGE**
Describe how to install all development dependencies and how to run an automated test-suite of some kind.
Potentially do this for multiple platforms.
```sh ```sh
make install make install
@ -36,6 +39,8 @@ npm test
## Release History ## Release History
**CHANGE**
* 0.2.1 * 0.2.1
* CHANGE: Update docs (module code remains unchanged) * CHANGE: Update docs (module code remains unchanged)
* 0.2.0 * 0.2.0
@ -51,24 +56,25 @@ npm test
## Meta ## Meta
Your Name – [@YourTwitter](https://twitter.com/dbader_org) – YourEmail@example.com Jim Martens – [@2martens](https://twitter.com/2martens) – github@2martens.de
Distributed under the XYZ license. See ``LICENSE`` for more information. Distributed under the Apache 2.0 license. See ``LICENSE`` for more information.
[https://github.com/yourname/github-link](https://github.com/dbader/) [https://github.com/2martens/](https://github.com/2martens/)
## Contributing ## Contributing
1. Fork it (<https://github.com/yourname/yourproject/fork>) 1. Fork it (<https://github.com/2martens/masterthesis/fork>)
2. Create your feature branch (`git checkout -b feature/fooBar`) 2. Create your feature branch (`git checkout -b feature/fooBar`)
3. Commit your changes (`git commit -am 'Add some fooBar'`) 3. Commit your changes (`git commit -am 'Add some fooBar'`)
4. Push to the branch (`git push origin feature/fooBar`) 4. Push to the branch (`git push origin feature/fooBar`)
5. Create a new Pull Request 5. Create a new Pull Request
<!-- Markdown link & img dfn's --> <!-- Markdown link & img dfn's -->
[npm-image]: https://img.shields.io/npm/v/datadog-metrics.svg?style=flat-square [dependencies]:https://img.shields.io/librariesio/release/pypi/twomartens.masterthesis.svg
[npm-url]: https://npmjs.org/package/datadog-metrics [pypi-license]: https://img.shields.io/pypi/l/twomartens.masterthesis.svg
[npm-downloads]: https://img.shields.io/npm/dm/datadog-metrics.svg?style=flat-square [pypi-url]: https://pypi.org/project/twomartens.masterthesis/
[travis-image]: https://img.shields.io/travis/dbader/node-datadog-metrics/master.svg?style=flat-square [pypi-downloads]: https://img.shields.io/pypi/dm/twomartens.masterthesis.svg
[travis-url]: https://travis-ci.org/dbader/node-datadog-metrics [pypi-python-versions]: https://img.shields.io/pypi/pyversions/twomartens.masterthesis.svg
[wiki]: https://github.com/yourname/yourproject/wiki [wiki]: https://github.com/2martens/masterthesis/wiki
[tf-gpu-support]: https://www.tensorflow.org/install/gpu