diff --git a/.gitignore b/.gitignore index 0b0fdad..9d3b29d 100644 --- a/.gitignore +++ b/.gitignore @@ -4,6 +4,7 @@ tests/*testdb/ db/ # Compiled / cythonized files +README.html docs/*.html build/ *.pyc @@ -16,6 +17,7 @@ nilmdb/server/rbtree.c dist/ nilmdb.egg-info/ venv/ +.eggs/ # Misc timeit*out diff --git a/README.md b/README.md new file mode 100644 index 0000000..689f687 --- /dev/null +++ b/README.md @@ -0,0 +1,33 @@ +# nilmdb: Non-Intrusive Load Monitor Database +by Jim Paris + +NilmDB requires Python 3.7 or newer. + +## Prerequisites: + + # Runtime and build environments + sudo apt install python3.7 python3.7-dev python3.7-venv python3-pip + + # Optional: create a new Python virtual environment to isolate + # dependencies. To leave the virtual environment, run "deactivate" + python -m venv venv + source venv/bin/activate + + # Install all Python dependencies from PyPI. + pip3 install -r requirements.txt + +## Test: + + python3 setup.py nosetests + +## Install: + + sudo python3 setup.py install + +## Usage: + + nilmdb-server --help + nilmdb-fsck --help + nilmtool --help + +See docs/wsgi.md for info on setting up a WSGI application in Apache. diff --git a/README.txt b/README.txt deleted file mode 100644 index 7111e10..0000000 --- a/README.txt +++ /dev/null @@ -1,31 +0,0 @@ -nilmdb: Non-Intrusive Load Monitor Database -by Jim Paris - -Prerequisites: - - # Runtime and build environments - sudo apt install python3.7 python3.7-dev python3.7-venv python3-pip - - # Optional: create a new Python virtual environment to isolate - # dependencies. To leave the virtual environment, run "deactivate" - python -m venv venv - source venv/bin/activate - - # Install all Python dependencies from PyPI. - pip3 install -r requirements.txt - -Test: - - python3 setup.py nosetests - -Install: - - sudo python3 setup.py install - -Usage: - - nilmdb-server --help - nilmdb-fsck --help - nilmtool --help - -See docs/wsgi.md for info on setting up a WSGI application in Apache.