-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Remove $ from README * Small README improvements * Add license badge
- Loading branch information
Showing
1 changed file
with
11 additions
and
10 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,33 +1,34 @@ | ||
|
||
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) | ||
|
||
# About | ||
This project aims to create simple songbook for storing, managing and viewing songs with their respective chords. The songs are loaded once and then all filtering/searching happens on the client which means it is usable even in conditions with low or almost no internet access as it can be preloaded. The site can also generate PDF files from selected songs for offline viewing or printing. | ||
|
||
# Getting Started | ||
|
||
First clone the repository from Github and switch to the new directory: | ||
First clone the repository from GitHub and switch to the new directory: | ||
|
||
$ git clone https://github.com/pehala/song-book.git | ||
$ cd song-book | ||
git clone https://github.com/pehala/song-book.git | ||
cd song-book | ||
|
||
Install pipenv and dependencies | ||
|
||
$ python -m pip install poetry | ||
$ poetry install | ||
python -m pip install poetry | ||
poetry install | ||
|
||
Then simply initialize the website: | ||
|
||
$ make init | ||
make init | ||
|
||
You can now run the development server: | ||
|
||
$ make run | ||
make run | ||
|
||
## FAQ | ||
|
||
1. pipenv install throws | ||
1. `poetry install` throws | ||
|
||
ERROR: Couldn't install package: rcssmin | ||
Package installation failed... | ||
|
||
Install apt-get install python3-dev (or yum install python3-devel etc.) | ||
Install `python3-dev` for Debian-based distro or `python3-devel` for RHEL-based | ||
|