Verified Commit 52196835 authored by Elias Häußler's avatar Elias Häußler 🐛

[DOCS] Beautify documentation

parent 7da2a5ed
[![build](https://travis-ci.com/eliashaeussler/trumpinator.svg?token=vkQdh4FDH2sRrf94RJjF&branch=master)](https://travis-ci.com/eliashaeussler/trumpinator)
[![license](https://img.shields.io/github/license/eliashaeussler/trumpinator.svg)](https://github.com/eliashaeussler/trumpinator/blob/master/LICENSE.md)
[![release](https://img.shields.io/github/release/eliashaeussler/trumpinator.svg)](https://GitHub.com/eliashaeussler/trumpinator/releases/)
[![license](https://img.shields.io/github/license/eliashaeussler/trumpinator.svg)](LICENSE.md)
[![release](https://img.shields.io/github/release/eliashaeussler/trumpinator.svg)](https://github.com/eliashaeussler/trumpinator/releases/)
# Trumpinator
Welcome to Trumpinator, the world's best opportunity to deal with Donald Trump's statements! Don't you like what he's talking about on Twitter? No problem, just scream everything you have on your mind inside your computer's mic and it will destroy all the crappy stuff @realdonaldtrump is talking about on Twitter!
Welcome to Trumpinator, the world's best opportunity to deal with Donald Trump's statements! Don't you like what he's
talking about on Twitter? No problem, just scream everything you have on your mind inside your computer's mic and it
will destroy all the crappy stuff [@realdonaldtrump](https://twitter.com/realDonaldTrump) is talking about on Twitter!
## What the hell is that?
*Trumpinator* is our new method to help you get rid of your bad mood in relation to Donald Trump. We all know that he's a unsuitable president and we want him to know our frustration about him. So we decided to develop a tiny program which reads the lastest 200 tweets of @realdonaldtrump and enables you to destroy all of them by screaming inside your computer's mic. You will see, it's freeing! :-)
## How to start
*Trumpinator* is a new method to help you get rid of your bad mood in relation to Donald Trump. We all know that he's an
unsuitable president and we want him to know our frustration about him. So we decided to develop a tiny program which
reads the lastest 200 tweets of [@realdonaldtrump](https://twitter.com/realDonaldTrump) and enables you to destroy all
of them by screaming inside your computer's mic. You will see, it's freeing! :grin:
## Requirements
There is just one thing you need: Download and install at least **Java 8** to run the program. You can get the latest
version of Java directly here: https://www.java.com/download/
## Usage
You can either run the program using the Processing project or the exported Build files.
### Processing source code
1. Clone or download the project from GitHub
2. Open Processing
3. Open the file *trumpinator.pde*. **Important: All files and folders need to be inside a folder called *trumpinator* (which they are, by default, when you clone the repository)**
4. Press *Run* (or Cmd+R / Ctrl+R)
3. Open the file [trumpinator.pde](trumpinator/trumpinator.pde).
**Important: All files and folders need to be inside a folder called *trumpinator* (which they are, by default, when
you clone the repository)**
4. Press `Run` or type `⌘`+`R` / `Ctrl`+`R`
### Build files
Download the Build files from the [Releases](https://github.com/eliashaeussler/trumpinator/releases) section for your Operating System and run them. The following systems are currently supported:
Head to the [Releases](https://github.com/eliashaeussler/trumpinator/releases) section and download the binary files for
your Operating System. After downloading, just run the binary file.
Currently the following operating systems are supported:
* macOS
* Windows (32-/64-bit)
* Linux (32-/64-bit)
## Requirements
There is just one thing you need: Download and install at least **Java 8** to run the program. You can get the latest version of Java directly here: https://www.java.com/download/
## Resources we have used
* Twitter4J (https://github.com/yusuke/twitter4j)
* Minim (https://github.com/ddf/Minim/)
* Some fonts downloaded from http://www.dafont.com/
## Resources
* [Twitter4J](https://github.com/yusuke/twitter4j)
* [Minim](https://github.com/ddf/Minim/)
* Some fonts downloaded from [dafont.com](http://www.dafont.com/)
## License
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
## License
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
[MIT License](LICENSE.md)
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment