From 2a64f398645d370622f27e02addec60a84dba581 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Petr=20H=C3=A1la?= Date: Sun, 10 Sep 2023 10:13:31 +0200 Subject: [PATCH] Readme improvements (#67) * Remove $ from README * Small README improvements * Add license badge --- README.md | 21 +++++++++++---------- 1 file changed, 11 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index c5f740f..313df61 100644 --- a/README.md +++ b/README.md @@ -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