/development_guides

Installation Instructions for Rideshare

Primary LanguageRuby

Development Guides

Table of Contents

What is this?

This repo expands on the development environment installation instructions in the Rideshare README.md.

This repo covers how to install and use additional software that readers work with.

If you spot bugs or have suggestions, please open an Issue or Pull Request!

macOS

Installation guides are provided for macOS. If you want to add tips for other operating systems, please open an Issue or Pull Request.

Conventions

Most of the programs here are command line programs, so you'll work in your terminal.

Each item has a Markdown file (.md) that can cover Installation, Dependencies, and possibly Troubleshooting or Usage sections.

The Table of Contents lists all items, and it's assembled from the Markdown files.

Generating the Table of Contents

The Table of Contents is generated. Regenerate it by following these steps:

  1. Run ruby generate_toc.rb from your terminal
  2. Open the new TOC block at the top of this file in your editor.
  3. Manually delete the old block below the new block, leaving only the new section.

When you're happy with the new TOC, commit the changes.

Links