extended README

This commit is contained in:
Marcel Kapfer 2017-07-29 20:05:23 +02:00
parent 1676c8e306
commit 0ef8e83035

View file

@ -1,6 +1,16 @@
# Scorelib # Scorelib
A free program for managing your music score collection. It runs on Linux and is written for the holy command line. Scorelib is a free CLI (command line interface) programm written in python and for linux only. The idea behind this tool is, to combine the lightning fast UX of a keyboard-only terminal usage and the fully digitalization of your music score library.
## Features
Scorelib is in an early state, so it doesnt include special features. The following ones are already implemented:
- Add new pieces
- Edit pieces
- Delete pieces (through the editing mode)
- List all pieces
- Search for a piece
## Installation ## Installation
@ -22,7 +32,7 @@ sudo make uninstall
## Usage ## Usage
When you first use the program, you have to initialize it. To do so start the program and enter `init` as a command. When you first use the program, you have to initialize it. To do so start the program and enter `init` as a command. This command creates the directory ~/.scorelib where Scorelib stores its data. After that Scorelib creates and initializes a SQlite database in that directory.
There are two different modes: the normal mode and the edit mode. When you start the program you start out in the normal mode with the prompt ` > ` and you can run the following commands: There are two different modes: the normal mode and the edit mode. When you start the program you start out in the normal mode with the prompt ` > ` and you can run the following commands:
@ -57,7 +67,7 @@ The program is licensed under GPL v3 license. If you want to contribute just fol
4. Push to the branch (`git push origin my-new-feature`) 4. Push to the branch (`git push origin my-new-feature`)
5. Create new pull request 5. Create new pull request
You can also add yourself to the CONTRIBUTORS.md file. (Create it if it doesn't exist) You can also add yourself to the CONTRIBUTORS.md file.
## Social ## Social