From 5fb222912db75430ccb1d925485d55fad13d4b73 Mon Sep 17 00:00:00 2001 From: Brian Peiris Date: Wed, 9 Sep 2015 12:36:17 -0400 Subject: [PATCH] Add table of contents to README The README has gotten quite large. Adding a table of contents might help, especially if you're just looking for the installation section. Generated using DocToc: https://github.com/thlorenz/doctoc --- README.markdown | 31 +++++++++++++++++++++++++++++-- 1 file changed, 29 insertions(+), 2 deletions(-) diff --git a/README.markdown b/README.markdown index e79f2e8..2cdacfb 100644 --- a/README.markdown +++ b/README.markdown @@ -1,11 +1,38 @@ # SCM Breeze [![TravisCI](https://secure.travis-ci.org/ndbroadbent/scm_breeze.png?branch=master)](http://travis-ci.org/ndbroadbent/scm_breeze) -### Streamline your SCM workflow. + +> Streamline your SCM workflow. **SCM Breeze** is a set of shell scripts (for `bash` and `zsh`) that enhance your interaction with git. It integrates with your shell to give you numbered file shortcuts, a repository index with tab completion, and many other useful features.
+- [SCM Breeze](#scm-breeze-) + - [Demos](#demos) + - [File Shortcuts](#file-shortcuts) + - [Git Status Shortcuts:](#git-status-shortcuts) + - ['ls' shortcuts:](#ls-shortcuts) + - [Other shortcuts](#other-shortcuts) + - [Keyboard bindings](#keyboard-bindings) + - [Repository Index](#repository-index) + - [Linking External Project Design Directories](#linking-external-project-design-directories) + - [1) Create and configure a root design directory](#1-create-and-configure-a-root-design-directory) + - [2) Initialize design directories for your projects](#2-initialize-design-directories-for-your-projects) + - [3) Link existing design directories into your projects](#3-link-existing-design-directories-into-your-projects) + - [Contributing tools / scripts](#contributing-tools--scripts) +- [Installation](#installation) +- [Updating](#updating) +- [Uninstall](#uninstall) +- [Configuration](#configuration) + - [1) Configure and use the provided SCM Breeze aliases](#1-configure-and-use-the-provided-scm-breeze-aliases) + - [2) Use your own aliases](#2-use-your-own-aliases) +- [Notes about Tab Completion for Aliases](#notes-about-tab-completion-for-aliases) + - [Bash](#bash) + - [Zsh](#zsh) +- [Contributing](#contributing) + +
+ ## Demos Adding a range of files, and pressing `Ctrl+X, C` to commit: @@ -363,5 +390,5 @@ Please feel free to fork and send pull requests, especially if you would like to for Mercurial, SVN, etc. -## Enjoy! +***Enjoy!***