diff --git a/README.md b/README.md index 74e6096..f34c935 100755 --- a/README.md +++ b/README.md @@ -1,43 +1,40 @@ -Morse Converter -=============== +# Morse Converter (Desktop Client) A writtenMorse and normal morse code converter. -A detailed description about this program can be found on http://marcel-kapfer.de/writtenmorse. +A detailed description about this program can be found on [marcel-kapfer.de/writtenmorse](https://marcel-kapfer.de/writtenmorse). ## Content - [Contribute](#contribute) - [Trello Board](#trello-board) - [Packages](#packages) - [Linux](#linux) - - [ubuntu](#ubuntu) + - [Ubuntu](#ubuntu) -## Contribute - -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** - -Feel free to 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). +## Contributing -You should also check out the issues and the Trello board. +For contributing to this project read my contribution guidlines at [mmk2410.org/contributing](https://mmk2410.org/contributing). -## Trello Board +If you have any questions feel free to contact me at [marcelmichaelkapfer@yahoo.co.nz](mailto:marcelmichaelkapfer@yahoo.co.nz), [Google+](https://plus.google.com/+MarcelMichaelKapfer), [Twitter](https://twitter.com/mmk2410), [GNUsocial](https://social.mmk2410.org/mmk2410), in a room at [phab.mmk2410.org](https://phab.mmk2410.org) or join the party at [irc.mmk2410.org](irc://irc.mmk2410.org). -[Feature & Development Board](https://trello.com/b/OUoy2iHg/morse-computer) +If you want to contribute code to this project check if your additions match with the [Google Java Style Guide](https://google.github.io/styleguide/javaguide.html) (you can download the XML style at [https://github.com/google/styleguide](https://github.com/google/styleguide)). + +The repository is at [phab.mmk2410.org/diffusion](https://phab.mmk2410.org/diffusion) and the bug tracker [phab.mmk2410.org/maniphest](https://phab.mmk2410.org/maniphest). ## Packages + ### Linux + #### Ubuntu I created an Ubuntu repository for the app. You can use it by running the following lines: -``sudo apt-add-repository ppa:mmk2410/morse-converter`` +``` +sudo apt-add-repository ppa:mmk2410/morse-converter -``sudo apt-get update`` +sudo apt-get update -``sudo apt-get install morse-converter`` +sudo apt-get install morse-converter +``` -[Launchpad](https://launchpad.net/~mmk2410/+archive/ubuntu/morse-converter) +View this package repository at [Launchpad](https://launchpad.net/~mmk2410/+archive/ubuntu/morse-converter).