81 lines
2.3 KiB
Markdown
81 lines
2.3 KiB
Markdown
# Masterthesis
|
||
> 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.
|
||
|
||
|
||
|
||
## Installation
|
||
|
||
```sh
|
||
pip install twomartens.masterthesis
|
||
```
|
||
|
||
Please refer to [GPU support][tf-gpu-support] for instructions on
|
||
installing the non-Python dependencies for `tensorflow`.
|
||
|
||
## 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.
|
||
|
||
_For more examples and usage, please refer to the [Wiki][wiki]._
|
||
|
||
## Development setup
|
||
|
||
**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
|
||
make install
|
||
npm test
|
||
```
|
||
|
||
## Release History
|
||
|
||
**CHANGE**
|
||
|
||
* 0.2.1
|
||
* CHANGE: Update docs (module code remains unchanged)
|
||
* 0.2.0
|
||
* CHANGE: Remove `setDefaultXYZ()`
|
||
* ADD: Add `init()`
|
||
* 0.1.1
|
||
* FIX: Crash when calling `baz()` (Thanks @GenerousContributorName!)
|
||
* 0.1.0
|
||
* The first proper release
|
||
* CHANGE: Rename `foo()` to `bar()`
|
||
* 0.0.1
|
||
* Work in progress
|
||
|
||
## Meta
|
||
|
||
Jim Martens – [@2martens](https://twitter.com/2martens) – github@2martens.de
|
||
|
||
Distributed under the Apache 2.0 license. See ``LICENSE`` for more information.
|
||
|
||
[https://github.com/2martens/](https://github.com/2martens/)
|
||
|
||
## Contributing
|
||
|
||
1. Fork it (<https://github.com/2martens/masterthesis/fork>)
|
||
2. Create your feature branch (`git checkout -b feature/fooBar`)
|
||
3. Commit your changes (`git commit -am 'Add some fooBar'`)
|
||
4. Push to the branch (`git push origin feature/fooBar`)
|
||
5. Create a new Pull Request
|
||
|
||
<!-- Markdown link & img dfn's -->
|
||
[dependencies]:https://img.shields.io/librariesio/release/pypi/twomartens.masterthesis.svg
|
||
[pypi-license]: https://img.shields.io/pypi/l/twomartens.masterthesis.svg
|
||
[pypi-url]: https://pypi.org/project/twomartens.masterthesis/
|
||
[pypi-downloads]: https://img.shields.io/pypi/dm/twomartens.masterthesis.svg
|
||
[pypi-python-versions]: https://img.shields.io/pypi/pyversions/twomartens.masterthesis.svg
|
||
[wiki]: https://github.com/2martens/masterthesis/wiki
|
||
[tf-gpu-support]: https://www.tensorflow.org/install/gpu
|