Skip to content

Commit

Permalink
Added table of contents in README
Browse files Browse the repository at this point in the history
  • Loading branch information
sirfoga committed Aug 26, 2017
1 parent 1d6d1bd commit 221fe01
Showing 1 changed file with 11 additions and 3 deletions.
14 changes: 11 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,7 @@

[![Build Status](https://travis-ci.org/sirfoga/pyhal.svg?branch=master)](https://travis-ci.org/sirfoga/pyhal) [![Build status](https://ci.appveyor.com/api/projects/status/isfmmdaqhkbgqaeu?svg=true)](https://ci.appveyor.com/project/sirfoga/pyhal) [![Coverage Status](https://coveralls.io/repos/github/sirfoga/pyhal/badge.svg?branch=master)](https://coveralls.io/github/sirfoga/pyhal?branch=master)

[![Code Health](https://landscape.io/github/sirfoga/pyhal/master/landscape.svg?style=flat)](https://landscape.io/github/sirfoga/hal/master)
[![Code Climate](https://lima.codeclimate.com/github/sirfoga/pyhal/badges/gpa.svg)](https://codeclimate.com/github/sirfoga/pyhal)
![pylint Score](https://mperlet.de/pybadge/badges/8.83.svg)
[![Code Health](https://landscape.io/github/sirfoga/pyhal/master/landscape.svg?style=flat)](https://landscape.io/github/sirfoga/hal/master) [![Code Climate](https://lima.codeclimate.com/github/sirfoga/pyhal/badges/gpa.svg)](https://codeclimate.com/github/sirfoga/pyhal) ![pylint Score](https://mperlet.de/pybadge/badges/8.83.svg)

[![PyPI version](https://badge.fury.io/py/PyHal.svg)](https://pypi.org/project/PyHal/) [![Requirements Status](https://requires.io/github/sirfoga/pyhal/requirements.svg?branch=master)](https://requires.io/github/sirfoga/pyhal/requirements/?branch=master) [![Documentation Status](https://readthedocs.org/projects/pyhal/badge/?version=latest)](http://pyhal.readthedocs.io/en/latest/?badge=latest)

Expand All @@ -17,6 +15,16 @@

![screenshot](logo.png)

**Table of Contents**

- [Install](#install)
- [Requirements](#requirements)
- [Python dependencies](#python-dependencies)
- [Examples](#examples)
- [Usage and documentation](#usage-and-documentation)
- [Questions and issues](#questions-and-issues)
- [LICENSE](#license)

## Install
- ``` $ pip3 install . --upgrade --force-reinstall ``` from the source
- ``` $ pip3 install pyhal``` via [pip](https://pypi.org/project/PyHal/)
Expand Down

0 comments on commit 221fe01

Please sign in to comment.