aboutsummaryrefslogtreecommitdiffstats
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README13
1 files changed, 10 insertions, 3 deletions
diff --git a/README b/README
index cfa23be..fdc6934 100644
--- a/README
+++ b/README
@@ -20,7 +20,7 @@ services and daemons. It is writen in python.
- no cookies, sessions, or server-side state
- compatible with lynx
-### Dependancies
+### Dependencies
- Augueas config file editing library, plus python bindings.
- The Flask lightweight pythonic web framework
@@ -34,12 +34,19 @@ The bundled CSS and image files are Twitter Bootstrap.
### Development
-To resolve dependancies on debian-based systems (wheezy or newer?):
+To resolve dependencies on debian-based systems (wheezy or newer?):
$ sudo apt-get install python-flask python-augeas ifupdown iw
You can run try running the UI on any old Linux machine, just don't submit any
forms unless you want your network configuration clobbered:
- $ ./torouterui.py --debug
+ $ ./runserver.py --debug
+
+### Install
+
+You probably want to either install a .deb package or do some virtualenv
+tomfoolery, but if not, you can install system-wide:
+
+ $ sudo ./setup.py install