The Bus Rapid Transit Planning Guide is the most comprehensive resource for planning a bus rapid transit (BRT) system, beginning with project preparation all the way through to implementation.
It is a huge effort by the Institute of Transportation and Development Policy (ITDP), and dozens of authors and reviewers.
This project aims to make the guide more accessible and keep it up-to-date:
- the guide is now available online in a website format that is easy to navigate
- a PDF of the guide is available to those that need to print it
- the online publication of updates is automatic
- the entire history of the guide is kept with Git
- revisions and contributions are easier with GitHub
Essentially, the project is divided in two top-level folders: the
/guide and the /generator.
The first has the files for the entire contents of the guide (text, images, tables, etc). The text is written in a simple but powerful format, that at the same allows ease of use, independence of content from style and is compatible with version control.
The second contains the source-code for the generator tool, that takes the text for the guide and the assets and builds, in a single run, both the full website and the PDF.
You can ask questions or report problems in the guide by opening a GitHub issue.
If instead you want to propose changes to either the guide (e.g. a typo fix or a new section) or, if you're a programmer or a designer, to the generator tool, please (fork the repository and) open a pull request.
More documentation on how to work with the guide and with GitHub will gradually become available. In the mean time, if you need help, do not hesitate to contact the geeks behind the curtain.
If you're seeing this error you problably have cloned the repository without supplying any authentication. This works great most of the time, but GitHub will enforce lower rate limits and you might trigger them if you're on a spree.
You should be able to fix that by updating the remote repository URL to use either authenticated HTTPS or SSH. Check your Git user interface help for instructions on how to do this. If you're on the command line, adjust and execute one of the following commands:
git remote set-url origin https://<your-github-username-here>@github.com/ITDP/the-online-brt-planning-guide
git remote set-url origin git@github.com:/ITDP/the-online-brt-planning-guide
First, you need to clone the project's repository.
Then, install Node.js, get an up-to-date manu package and install it with npm install -g <path-to-downloaded-tgz-file> (npm is automatically installed with Node.js).
(You can also build manu locally from the sources; see .robrt.Dockerfile/.robrt.json for how it's done in the server)
With manu installed you should be able to run manu in your command line.
Try manu --help to query the available commands and options.
You can generate the guide with manu generate guide/index.manu .generated in a command line at the root of local copy of the project.
This will populate a .generated directory with .html and .tex files.
At this point, the website is already functional, it's just a matter of starting a server (configuring it to automatically try adding .html extensions).
Since we already have Node.js installed for manu, the easiest way to do this is with http-server (you can install it with npm install -g http-server):
also at the root folder of the project, run http-server .generated/html --ext html -o.
To create the PDF you'll need a working LaTeX installation with lualatex and latexmk:
navigate to .generated/pdf and run latexmk -lualatex book.tex.
(You may notice that the generated PDF is huge; the server automatically compacts all images before running LaTeX, according to their resulting physical size and reasonable assumptions on printer limitations)