Online collaborative version of the BRT Planning Guide
Haxe HTML CSS TeX JavaScript Shell
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
generator
guide
server
.gitattributes
.gitignore
.robrt.Dockerfile
.robrt.json
.travis.yml
LICENSE.md
README.md

README.md

The Online BRT Planning Guide Current version

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

File structure

Essentially, the project is divided in three top-level folders:

  • /guide: the entire content of the guide (text, images, tables, etc.);
  • /generator: the source-code for manu;
  • and auxiliary files for the /server

The text is written in a simple but powerful manu-script format that, at the same time, allows ease of use, independence of content from style and is compatible with version control.

The generator tool – manu – takes the text and assets for the guide and builds , in a single run, both the full website and the PDF.

Contributing

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.

Frequently asked questions

How to work locally?

You will need to clone the project's repository.

How to run manu and generate the guide when working locally?

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 is 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.

How to test the locally generated website?

After running manu, 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).

Then, also at the root folder of the project, simply run http-server .generated/html --ext html and navigate to the indicated page.

How to build the PDF?

To create the PDF you'll need a working LaTeX installation with lualatex and latexmk. After running manu, navigate to .generated/pdf and run latexmk -lualatex book.tex.

You may notice that the PDF you generate locally is huge is huge in comparison to the one we provide. That's because our server automatically compacts all images before running LaTeX, according to their resulting physical size and reasonable assumptions on printer limitations. You can experiment with that as well by running the compress-pdf-assets.sh script (note: for this you'll need bash, bc and ImageMagick).

What to do when LFS fails with "rate limit reached for unauthenticated requests" error?

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

What to do when a push fails on the LFS section with "no such file or directory"?

You probably have a reference in your commit history to a particular version of a file that you did not need yet; thus, git-lfs has yet to fetch you a copy of it.

This mostly happens when you start working on top a recent master branch that has assets that have already been deleted or updated. Then, when you try to push your changes to your fork, you need to send it those old assets as well but you still don't have them.

This usually can be solved with:

git lfs fetch --all origin