Merge pull request #188 from brianpeiris/patch-2

Add table of contents to README
This commit is contained in:
Nathan Broadbent
2016-05-14 22:32:49 +07:00

View File

@@ -3,13 +3,40 @@
## I still use it every day but it does everything I need. ## I still use it every day but it does everything I need.
# SCM Breeze [![TravisCI](https://secure.travis-ci.org/ndbroadbent/scm_breeze.png?branch=master)](http://travis-ci.org/ndbroadbent/scm_breeze) # 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, **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. a repository index with tab completion, and many other useful features.
<hr/> <hr/>
- [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)
<hr/>
## Demos ## Demos
Adding a range of files, and pressing `Ctrl+X, C` to commit: Adding a range of files, and pressing `Ctrl+X, C` to commit:
@@ -367,5 +394,5 @@ Please feel free to fork and send pull requests, especially if you would like to
for Mercurial, SVN, etc. for Mercurial, SVN, etc.
## Enjoy! ***Enjoy!***