Skip to content

Commit

Permalink
Update docs index description to cover programmer and non-programmer …
Browse files Browse the repository at this point in the history
…audiences with proper documentation sections
  • Loading branch information
titus-ong committed Jul 26, 2020
1 parent 638b669 commit b81b6ee
Showing 1 changed file with 7 additions and 5 deletions.
12 changes: 7 additions & 5 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,9 @@ Welcome to chordparser's documentation!

chordparser is a Python 3 package that provides a musical framework for analysing chords. The :doc:`Introduction <introduction>` covers what it is and why it is.

Get started with :doc:`Installation <installation>` and then jump right into using chordparser with the :doc:`Quick Start <quickstart>`. The rest of the docs describe the Parser and each musical class that chordparser provides in detail so you can use the framework effectively.
If you are a musician, not a programmer, and you just want to see chordparser in action, the `Colab notebook <https://colab.research.google.com/drive/1T5WcH2WMHqpqbJrzxDt_Mg03lw1aXho7?usp=sharing>`_ is for you. It showcases the functions of chordparser and you can even use it for your own chord sheets without knowing any programming!

If you are a programmer however, then get started with :doc:`Installation <installation>` and jump right into using chordparser with the :doc:`hands-on Tutorial <tutorial>`. The :doc:`How-to guides <howto/main>` provide step-by-step guides on using different aspects of chordparser, while the :doc:`Reference <reference/main>` gives a full technical reference to all of chordparser's classes. Finally, the :doc:`Background section <background/main>` provides explanation and discussion of key topics.

--------
Contents
Expand All @@ -15,10 +17,10 @@ Contents

introduction
installation
quickstart
parser
music/main
helpers/main
tutorial
howto/main
reference/main
background/main
authors
contributing
licence
Expand Down

0 comments on commit b81b6ee

Please sign in to comment.