add presentation base
This commit is contained in:
28
README.md
28
README.md
@@ -10,19 +10,29 @@ Clone the repository:
|
||||
|
||||
Install the dependencies:
|
||||
|
||||
`cd pythagoras`
|
||||
|
||||
`python -m venv venv`
|
||||
|
||||
`source venv/bin/activate`
|
||||
|
||||
`pip install -r requirements.txt`
|
||||
`sudo pacman -S python-virtualenv`
|
||||
|
||||
## Running the app
|
||||
|
||||
Simply run the main Python file to start the server:
|
||||
Simply execute the **run** recipe in the Makefile to start the server:
|
||||
|
||||
`python main.py`
|
||||
`make run`
|
||||
|
||||
Note that run is also the default recipe. So `make` works too.
|
||||
|
||||
The run recipe should take care of everything for you... enjoy!
|
||||
|
||||
## Cleaning up the mess
|
||||
|
||||
If you wish to go back to a clean slate just run:
|
||||
|
||||
`make clean`
|
||||
|
||||
## Packing for production
|
||||
|
||||
To make an archive `pythagoras.tar.xz` in project root simply run:
|
||||
|
||||
`make pack`
|
||||
|
||||
## Usage
|
||||
|
||||
|
Reference in New Issue
Block a user