Skip to content

Commit

Permalink
docs(README): fix toc
Browse files Browse the repository at this point in the history
  • Loading branch information
Ninjani committed Jan 20, 2021
1 parent 342146e commit b8562c1
Showing 1 changed file with 19 additions and 13 deletions.
32 changes: 19 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,37 +12,43 @@ knowledge-base wiki without you having to actually type your knowledge out.

## Table of Contents

* [Installation requirements](#installation-requirements)
* [Binaries](#binaries)
* [Install](#install)
* [Installation requirements](#installation-requirements)
* [Binaries](#binaries)
* [With brew (OSX)](#with-brew-osx)
* [Contributing](#contributing)
* [Motivation](#motivation)
* [A typical workflow](#a-typical-workflow)
* [Some advantages](#some-advantages)
* [Customization](#customization)
* [Hypothesis](#hypothesis)
* [Knowledge base](#knowledge-base)
* [Knowledge base directory](#knowledge-base-directory)
* [Annotation template](#annotation-template)
* [Grouping annotations into folders and pages](#grouping-annotations-into-folders-and-pages)
* [Index link template](#index-link-template)
* [Index filename](#index-filename)
* [File extensions](#file-extensions)
* [Hypothesis](#hypothesis)
* [Knowledge base](#knowledge-base)
* [Knowledge base directory](#knowledge-base-directory)
* [Annotation template](#annotation-template)
* [Page template](#page-template)
* [Grouping annotations into folders and pages](#grouping-annotations-into-folders-and-pages)
* [Sorting annotations within a page](#sorting-annotations-within-a-page)
* [Index link template](#index-link-template)
* [Index filename](#index-filename)
* [File extensions](#file-extensions)
* [Why "Gooseberry"?](#why-gooseberry)

## Installation requirements
## Install

### Installation requirements

* A Hypothesis account, and a personal API token obtained as described [here](https://h.readthedocs.io/en/latest/api/authorization/).
* [bat](https://github.com/sharkdp/bat) to display highlighted markdown in the terminal.

## Binaries
### Binaries

See the [releases](https://github.com/out-of-cheese-error/gooseberry/releases/latest)

* OSX - allow `gooseberry` via System Preferences (necessary in Catalina at least)
* Linux - `chmod +x gooseberry`
* Currently, doesn't work on Windows (waiting on [this issue](https://github.com/lotabout/skim/issues/293))

## With brew (OSX)
### With brew (OSX)

```bash
brew tap out-of-cheese-error/gooseberry && brew install gooseberry
Expand Down

0 comments on commit b8562c1

Please sign in to comment.