Updated contribution guide and TODO.

Author: BohdanOrlov

HowTo/HOWTOPR.md

@@ -1,22 +1,40 @@
 ## How to add new topics or materials
 
-#### Steps
+#### One file to rule them all
+<img src="CONTENTSCREENSHOT.png" width="720">
 
-![Content screenshot](CONTENTSCREENSHOT.png)
+### How to add topics and materials
 
-1. Go to `RoadmapProject/Script`
-1. Open `Content.yml`, add topics or links to materials
-1. Run `main.swift`
-1. Commit and push all generated files and changes
-1. Submit a pull request
+1. Open `RoadmapProject/Script/Content.yml` in your fork repository 
+1. Add topics and/or links to materials
+1. Commit and push `Content.yml` changes to Github 
+2. Submit a pull request
+
+#### When your changes will be applied
+
+1. Wait for your pull request to be merged
+1. Wait up to 5 minutes for Travis CI to regenerate roadmap images and text version
 
-Note. I've used Sublime text for editing YAML.
 
-#### Prerequisites
+#### Prerequisites for adding topics and materials
 
 1. Git
-1. Latest Swift/Xcode
 1. Fork of the repository
+2. YAML editor, e.g. [Sublime Text](https://www.sublimetext.com/).
+
+### How to run generation script locally (Optional)
+The generation script will generate images and the text version of the roadmap.
+
+1. run `./generateAll.sh`
+
+**or**
+
+1. Go to `RoadmapProject/Script`
+2. Run `./main.swift`
+
+##### Prerequisites for running the script locally
+
+1. Latest Swift/Xcode
 1. Prepare PlantUML:
 	1. Install [JDK](http://www.oracle.com/technetwork/java/javase/downloads/jdk9-downloads-3848520.html)
 	1. Install Homebrew:
@@ -29,7 +47,7 @@ Note. I've used Sublime text for editing YAML.
 	1. Go to `Roadmap Project/Script/` 
 	1. Run `java -jar plantuml.jar -testdot` to check if installed correctly.
 
-#### How to debug script
+##### How to debug script (Optional)
 Use `Roadmap Project/Roadmap.xcodeproj` to run and debug script.
 
 Xcode runs and debugs an executable binary, thus generated output will be put next to the binary.

README.md

@@ -37,11 +37,12 @@ Roadmap of essential topics. Roadmap for all topics is [here.](RoadmapProject/Sc
 
 ## 🤝 How to contribute
 
-- add additional topics 
-- add missing study materials 
-- throw ideas at me on Twitter [![Twitter URL](https://img.shields.io/twitter/url/https/twitter.com/kamranahmedse.svg?style=social&label=@bohdan_orlov)](https://twitter.com/bohdan_orlov)
+- add new topics to `Content.yml`
+- add missing study materials to `Content.yml`
+- throw ideas at me on [![Twitter: @PatrickKladek](https://img.shields.io/badge/twitter-@Bohdan_Orlov-4d66b3.svg?style=flat)](https://twitter.com/bohdan_orlov)
 
-[Adding new topics or materials can't be easier.](HowTo/HOWTOPR.md)
+
+[The complete contribution guide.](HowTo/HOWTOPR.md)
 
 
 ## ☑️ TODO
@@ -54,7 +55,10 @@ Roadmap of essential topics. Roadmap for all topics is [here.](RoadmapProject/Sc
 	- [ ] handle errors of parsing Yaml into Topics and Resources
 	- [ ] handle file read/write errors
 	- [ ] handle image generation errors
-- [ ] run the script automaticaly on PRs if the content file is changed
+- [x] automatic regeneration of roadmap after every commit
+- [ ] automatic validation of content format on PR
+- [ ] make sure Travis doesn't deploy if generation script fails
+
 ## License
 
 [![License: CC BY 4.0](https://img.shields.io/badge/License-CC%20BY%204.0-lightgrey.svg)](https://creativecommons.org/licenses/by/4.0/)