mirror of
https://github.com/freedombox/FreedomBox.git
synced 2026-01-21 07:55:00 +00:00
defcb43883
Simplejson is an externally mainainted version of json library available in Python 2.6 and up. It supports Python 2.5 which were are not targetting. It also boasts better speed which is not at all a factor for us.
48 lines
1.2 KiB
Plaintext
48 lines
1.2 KiB
Plaintext
# Quick Start
|
|
|
|
## Installing Plinth
|
|
|
|
Install the dependencies:
|
|
|
|
apt-get install libpython2.7 pandoc psmisc python2.7 python-bcrypt python-cherrypy3 python-django python-passlib python-bootstrapform libjs-twitter-bootstrap sudo
|
|
|
|
Unzip and untar the source into a directory. Change to the directory
|
|
containing the program. Run:
|
|
|
|
$ make
|
|
|
|
To start Plinth, run:
|
|
|
|
$ ./start.sh
|
|
|
|
and point your web browser at `localhost:8000`. The default username is "admin"
|
|
and the default password is "secret".
|
|
|
|
## Dependencies
|
|
|
|
* cherrypy - python web engine v3+
|
|
|
|
* python - tested with version 2.6.6
|
|
|
|
* *GNU Make* is used to build the templates and such.
|
|
|
|
* *libjs-twitter-bootstrap* - A responsive, mobile first front-end framework
|
|
|
|
* *python-bootstrapform* - Render django forms for Twitter Bootstrap
|
|
|
|
The documentation has some dependencies too.
|
|
|
|
* *Markdown* is used to format and style docs.
|
|
|
|
* *Pandoc* converts the markdown to different formats.
|
|
|
|
* *PDFLatex* generates pdf versions of the documentation.
|
|
|
|
* *GNU Make* processes /doc/Makefile.
|
|
|
|
## Building the Documentation
|
|
|
|
Documentation has been collected into a pdf that can be built using
|
|
`make doc`. It also gets built into smaller files and other formats,
|
|
including one suitable for install as a man page.
|