diff --git a/.gitignore b/.gitignore index 807b93c..6cc9d35 100644 --- a/.gitignore +++ b/.gitignore @@ -1,8 +1,5 @@ -<<<<<<< Updated upstream -env/* -pocwww.egg* -======= env/* +pocwww.egg* +pocwww/__pycache__/* pocwww.egg-info/* ->>>>>>> Stashed changes diff --git a/README.txt b/README.txt index ff46e9e..1f1e5c6 100644 --- a/README.txt +++ b/README.txt @@ -1,29 +1,12 @@ -POC Web Interface -=============================== +# Henry Pump POC Web Interface -Getting Started ---------------- +## Installation +1. Install Python 3 & venv with `sudo apt-get install python3 python3-venv` -- Change directory into your newly created project. +2. From the root of the POC-Java-www directory, run `python3 -m venv env` to create the virtual environment. - cd POC Web Interface +3. Update the install of pip `env/binpip install --upgrade pip setuptools` -- Create a Python virtual environment. +4. Install the python module `env/bin/pip install .` - python3 -m venv env - -- Upgrade packaging tools. - - env/bin/pip install --upgrade pip setuptools - -- Install the project in editable mode with its testing requirements. - - env/bin/pip install -e ".[testing]" - -- Run your project's tests. - - env/bin/pytest - -- Run your project. - - env/bin/pserve development.ini +5. Test the web server `env/bin/pserve production.ini`