HOWTOPR.md

How to add new topics or materials

Steps

2. Go to Roadmap Project/Script
3. Open Content.yml, add topics or links to materials
4. Run main.swift
5. Commit and push all generated files and changes
6. Submit a pull request

Note. I've used Sublime text for editing YAML.

Prerequisites

1. Git
2. Latest Swift/xCode
3. Fork of the repository
4. Prepare PlantUML:
   1. Install JDK
   2. Install Homebrew:
      • /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
   3. Install GraphViz:
      • brew install libtool
      • brew link libtool
      • brew install graphviz
      • brew link --overwrite graphviz
   4. Go to Roadmap Project/Script/
   5. Run java -jar plantuml.jar -testdot to check if installed correctly.

How to debug script

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.

Always run script via terminal before submitting a PR.