Skip to content

Commit

Permalink
[doc] Add Table of Contents to README
Browse files Browse the repository at this point in the history
Closes #152
  • Loading branch information
bbugyi200 committed Jul 21, 2019
1 parent add2930 commit 56b9d51
Showing 1 changed file with 23 additions and 7 deletions.
30 changes: 23 additions & 7 deletions README.md
Expand Up @@ -6,10 +6,26 @@

![demo]

## Table of Contents

* [Usage](#usage)
* [Command-line Interface](#command-line-interface)
* [Local vs Global](#local-vs-global)
* [Funk Definition Shortcuts](#funk-definition-shortcuts)
* [Special cd Funks](#special-cd-funks)
* [Simulate Shell Variables](#simulate-shell-variables)
* [The "$@" Special Parameter](#the--special-parameter)
* [Installation](#installation)
* [Using pip to Install](#using-pip-to-install)
* [Building from Source](#building-from-source)
* [Additional Installation Steps](#additional-installation-steps)
* [Similar Projects](#similar-projects)
* [Contributions](#contributions)

## Usage
Funks are manipulated using the `funky` and `gfunky` commands. These commands have the same user interface, which is specified in the [Command-line Interface](#cli) section. The difference between the two commands is treated in the [Local vs Global](#lvg) section.
Funks are manipulated using the `funky` and `gfunky` commands. These commands have the same user interface, which is specified in the [Command-line Interface](#command-line-interface) section. The difference between the two commands is treated in the [Local vs Global](#local-vs-global) section.

### <a name="cli">Command-line Interface</cli>
### Command-line Interface
```
usage: funky [-h] [-d] [-v] [--version] [--color {y,n}] [-a FUNK] [-r [FUNK]]
[-e FUNK] [-R OLD NEW]
Expand Down Expand Up @@ -42,12 +58,12 @@ Action Commands:
the trailing '..') will be displayed.
```

### <a name="lvg">Local vs Global</a>
### Local vs Global

**Local** funks are stored using a hidden database file that is located in the same directory
where the funk was created. These can be manipulated using the action command options described
above. Once created, a local funk can be used just like any other command or normal funk---as
long as you have activated the provided shell extension (see [Additional Install Steps](#AIS)) and are
long as you have activated the provided shell extension (see [Additional Install Steps](#additional-installation-steps)) and are
inside of the directory where the local funk was originally defined.

**Global** funks, on the other hand, are stored in your home directory (``/home/<user>``) and can
Expand Down Expand Up @@ -100,7 +116,7 @@ See the official [Bash docs] for more information on Bash's special parameters.

## Installation

#### Using `pip` to Install
### Using `pip` to Install

To install funky, run this command in your terminal:

Expand All @@ -117,7 +133,7 @@ you through the process.
[Python installation guide]: http://docs.python-guide.org/en/latest/starting/installation/


#### Building from Source
### Building from Source

You can either clone the public repository:

Expand All @@ -137,7 +153,7 @@ Once you have a copy of the source, you can install funky by running:
make install
```

#### <a name="AIS">Additional Installation Steps</a>
### Additional Installation Steps

For the best experience, funky needs to be integrated into your shell environment using the
provided shell script.
Expand Down

0 comments on commit 56b9d51

Please sign in to comment.