From 79850f500b4623d9458bbf1e3ac48f0390daa510 Mon Sep 17 00:00:00 2001 From: th3r00t Date: Mon, 3 Aug 2020 13:18:44 -0400 Subject: [PATCH] Update README.md --- README.md | 72 +++++++++++++++++++++++++------------------------------ 1 file changed, 33 insertions(+), 39 deletions(-) diff --git a/README.md b/README.md index c78e762..f72142a 100755 --- a/README.md +++ b/README.md @@ -20,7 +20,7 @@ Follow or influence development @

## Current Features * Recursive Scanning -* Library Stored in PostgreSql database +* PostgreSql Library * [Django](https://www.djangoproject.com/) based frontend * Basic seaching via a SearchVector of author, title, & file_name fields. * Ebook Downloading @@ -58,13 +58,11 @@ Follow or influence development @

* [x] Control panel * [x] Book details -## Installation Example - -pyShelf Installation Video - ## Installation & Support Information -* [SUPPORT.md](https://github.com/th3r00t/pyShelf/blob/development/.github/SUPPORT.md) +# Installation + +This project is targeted towards Network Administrators, and home enthusiasts whom I assume will know how to setup a [Django](https://www.djangoproject.com/) app, and a [PostgreSQL](https://www.postgresql.org/) server. For those unfamiliar with the required setup please see the docker section below. ### Pre-req Dependencies @@ -72,41 +70,32 @@ Follow or influence development @

* python3 * pip -# Installation - -This project is targeted towards Network Administrators, and home enthusiasts whom I assume will know how to setup a [Django](https://www.djangoproject.com/) app, and a -[PostgreSQL](https://www.postgresql.org/) server. +setup configurations as discussed in [SUPPORT.md](https://github.com/th3r00t/pyShelf/blob/development/.github/SUPPORT.md) Once your environment is ready very little is required to get the system up and running: -* From the main directory - * setup configurations as discussed in [SUPPORT.md](https://github.com/th3r00t/pyShelf/blob/development/.github/SUPPORT.md) - * Run the following commands -` -pip install -r requirements.txt -cd src -python manage.py makemigrations -python manage.py makemigration interface -python manage.py migrate -python manage.py migrate interface -cd .. -./configure -./importBooks -` + +From the main directory + +`pip install -r requirements.txt` + +`cd src` + +`python manage.py makemigrations` + +`python manage.py makemigration interface` + +`python manage.py migrate` + +`python manage.py migrate interface` + +`cd ..` + +`./configure` + +`./importBooks` + Browse to the site as defined in your apache | nginx config -## Development - -* [`pre-commit`](https://pre-commit.com/) -_Before developing, run `pre-commit install` See the [documentation](https://pre-commit.com/) for more information._ - -* ['Doxygen'](http://www.doxygen.nl/) -_Any changes to source should be documented and have run doxygen doxygen.conf prior to commiting._ - -* ['sem-ver'](https://semver.org) -_Before advancing version numbers be sure to set PROJECT_NUMBER in doxygen.conf accordingly._ - -## Configuration - Running via the [Django](https://www.djangoproject.com/) test server might be possible, albeit not recomended. ## Docker @@ -173,6 +162,11 @@ The Docker image is still new, so there could still be some issues and missing f ### Terminal Backend for catalogue maintenance -### Calculate page count from total characters +## Development - * (Thanks to @Fireblend for the idea) https://github.com/th3r00t/pyShelf/issues/3 +* [`pre-commit`](https://pre-commit.com/) +_Before developing, run `pre-commit install` See the [documentation](https://pre-commit.com/) for more information._ +* ['Doxygen'](http://www.doxygen.nl/) +_Any changes to source should be documented and have run doxygen doxygen.conf prior to commiting._ +* ['sem-ver'](https://semver.org) +_Before advancing version numbers be sure to set PROJECT_NUMBER in doxygen.conf accordingly._