Browse Source

Clean up README

tags/nilmdb-2.0.0^0
Jim Paris 2 years ago
parent
commit
671f87b047
3 changed files with 35 additions and 31 deletions
  1. +2
    -0
      .gitignore
  2. +33
    -0
      README.md
  3. +0
    -31
      README.txt

+ 2
- 0
.gitignore View File

@@ -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


+ 33
- 0
README.md View File

@@ -0,0 +1,33 @@
# nilmdb: Non-Intrusive Load Monitor Database
by Jim Paris <jim@jtan.com>

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.

+ 0
- 31
README.txt View File

@@ -1,31 +0,0 @@
nilmdb: Non-Intrusive Load Monitor Database
by Jim Paris <jim@jtan.com>

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.

Loading…
Cancel
Save