Updated README
This commit is contained in:
parent
04a321ed10
commit
84556fa038
1 changed files with 11 additions and 27 deletions
38
README.md
38
README.md
|
@ -1,29 +1,21 @@
|
||||||
# Material Design
|
# writtenMorse Android Converter
|
||||||
|
|
||||||
A writtenMorse and normal morse code converter for Android. You can find more information about this app on http://marcel-kapfer.de/writtenmorse.
|
A writtenMorse and normal morse code converter for Android. You can find more information about this app on the [GitLab Wiki](https://gitlab.com/mmk2410/writtenmorse-specs/wikis/Home).
|
||||||
|
|
||||||
## Design
|
![Image](https://gitlab.com/mmk2410/morse-converter-android/raw/master/feature-graphic.png)
|
||||||
|
|
||||||
This is how it looks:
|
Get it on [Google Play](https://play.google.com/store/apps/details?id=de.marcelkapfer.morseconverter)
|
||||||
![Image](http://marcel-kapfer.de/writtenmorse/presentation-graphic.png)
|
|
||||||
|
|
||||||
## Contribute
|
## Contribute
|
||||||
|
|
||||||
1. Fork it
|
1. Fork it
|
||||||
2. Create a feature branch with a meaningful name (`git checkout -b my-new-feature`)
|
2. Create your feature branch (`git checkout -b my-new-feature`)
|
||||||
3. Add yourself to the CONTRIBUTORS file
|
3. Commit your changes (`git commit -am 'Add some feature'`)
|
||||||
4. Commit your changes (`git commit -am 'Add some feature'`)
|
4. Add yourself to the CONTRIBUTORS file
|
||||||
5. Push to your branch (`git push origin my-new-feature`)
|
5. Push to the branch (`git push origin my-new-feature`)
|
||||||
6. Create a new pull request
|
6. **Create a new merge request**
|
||||||
|
|
||||||
You can always write me a mail at marcelmichaelkapfer@yahoo.co.nz or contact me on [Google+](https://plus.google.com/+MarcelMichaelKapfer) or [Twitter](https://twitter.com/MarcelKapfer).
|
You can always write me a mail at [me@mmk2410.org](mailto:me@mmk2410.org) or contact me on [Twitter](https://twitter.com/MarcelKapfer).
|
||||||
|
|
||||||
|
|
||||||
You can also check out the issues and the Trello board.
|
|
||||||
|
|
||||||
## Trello Board
|
|
||||||
|
|
||||||
[Feature & Development Board](https://trello.com/b/SGMIGVbI/morse-android)
|
|
||||||
|
|
||||||
## Beta testing
|
## Beta testing
|
||||||
|
|
||||||
|
@ -31,12 +23,4 @@ Would you like to test new features before they land in the public version? Just
|
||||||
|
|
||||||
## Used Libraries
|
## Used Libraries
|
||||||
|
|
||||||
[Neokree's Material Navigation Drawer](https://github.com/neokree/MaterialNavigationDrawer)
|
* [Neokree's Material Navigation Drawer](https://github.com/neokree/MaterialNavigationDrawer)
|
||||||
|
|
||||||
## Contributing
|
|
||||||
|
|
||||||
1. Fork it
|
|
||||||
2. Create your feature branch (`git checkout -b my-new-feature`)
|
|
||||||
3. Commit your changes (`git commit -am 'Add some feature'`)
|
|
||||||
4. Push to the branch (`git push origin my-new-feature`)
|
|
||||||
5. **Create New Pull Request**
|
|
||||||
|
|
Reference in a new issue