Updated README, INSTALL and THANKS for 1.4-alpha1 release.

This commit is contained in:
Emanuel Schuetze 2013-04-24 14:26:09 +02:00
parent 851e1ce805
commit 31cb82efd2
3 changed files with 35 additions and 32 deletions

View File

@ -1,4 +1,4 @@
Installation Instructions for OpenSlides 1.3 Installation Instructions for OpenSlides 1.4
============================================ ============================================
Content Content
@ -45,8 +45,13 @@ I. Installation on GNU/Linux and MacOSX using the Python Package Index (PyPI)
OpenSlides will install the following required python packages: OpenSlides will install the following required python packages:
+ Django + Django
+ django-mptt + django-mptt
+ ReportLab Toolkit + pillow
+ Python Imaging Library (PIL) + qrcode
+ reportlab
+ tornado
+ bleach
+ beautifulsoup4
+ html5lib
4. Start OpenSlides server and open URL in your default browser: 4. Start OpenSlides server and open URL in your default browser:
@ -65,17 +70,14 @@ I. Installation on GNU/Linux and MacOSX using the Python Package Index (PyPI)
II. Installation on GNU/Linux and MacOSX using the sources II. Installation on GNU/Linux and MacOSX using the sources
---------------------------------------------------------- ----------------------------------------------------------
1. Install requirements: 1. Check requirements:
OpenSlides requires following programs, which should be Make sure that you have installed Python Programming Language 2
installed first: (>= 2.6) and virtualenv (>= 1.4.1) on your system. You will also
+ Python Programming Language 2 (>= 2.6) need the Python development headers.
+ virtualenv (>= 1.4.1)
+ ReportLab Toolkit
+ Python Imaging Library (PIL)
E. g. for Ubuntu run: E. g. for Ubuntu run:
$ sudo apt-get install python python-virtualenv python-reportlab python-imaging $ sudo apt-get install python-dev python-virtualenv
2. Get OpenSlides: 2. Get OpenSlides:
@ -83,14 +85,15 @@ II. Installation on GNU/Linux and MacOSX using the sources
OR OR
b) Clone development version from OpenSlides' github repository b) Clone current master version from OpenSlides' GitHub repository
https://github.com/OpenSlides/OpenSlides. This requires Git, https://github.com/OpenSlides/OpenSlides.
see http://git-scm.com/.
E. g. for Ubuntu run:
$ sudo apt-get install git
$ git clone git://github.com/OpenSlides/OpenSlides.git OpenSlides $ git clone git://github.com/OpenSlides/OpenSlides.git OpenSlides
This requires Git (see http://git-scm.com/).
To install Git e.g. on Ubuntu run:
$ sudo apt-get install git
3. Setup a virtual environment with virtualenv (optional): 3. Setup a virtual environment with virtualenv (optional):
You can setup a virtual environment to install OpenSlides as You can setup a virtual environment to install OpenSlides as
@ -105,22 +108,16 @@ II. Installation on GNU/Linux and MacOSX using the sources
$ virtualenv .venv $ virtualenv .venv
$ source .venv/bin/activate $ source .venv/bin/activate
4. Install the required python-packages: 4. Install all required python packages:
$ pip install django django-mptt $ pip install -r requirements.txt
If you use python < 2.6 you also have to install simplejson:
$ pip install simplejson
If requirements reportlab or PIL still missing (see 1.):
$ pip install reportlab pil
5. Start OpenSlides server and open URL in your default browser: 5. Start OpenSlides server and open URL in your default browser:
$ python start.py $ python start.py
If you run this script the first time a new database and the If you run this script the first time a new database and the
admin account are created. Please change the password after admin account will be created. Please change the password after
first login! first login!
Username: admin Username: admin
@ -131,7 +128,10 @@ II. Installation on GNU/Linux and MacOSX using the sources
6. Restart OpenSlides: 6. Restart OpenSlides:
To restart OpenSlides after closing the terminal activate the To restart OpenSlides after closing the terminal activate the
virtual environment (see 4.) before starting the server (see 6.). virtual environment before starting the server:
$ source .venv/bin/activate
$ python start.py
III. Installation on Windows (32bit) using the Python Package Index (PyPI) III. Installation on Windows (32bit) using the Python Package Index (PyPI)

View File

@ -2,7 +2,7 @@
English README file for OpenSlides English README file for OpenSlides
================================== ==================================
This is OpenSlides, version 1.4.0 (unreleased). This is OpenSlides, version 1.4-alpha1 (2013-04-24).
What is OpenSlides? What is OpenSlides?
@ -70,6 +70,9 @@ The following command line options are available:
--no-reload --no-reload
Does not reload the development server Does not reload the development server
--no-browser
Do not automatically start web browser.
--version --version
Show version and exit. Show version and exit.

6
THANKS
View File

@ -16,6 +16,9 @@ OpenSlides uses parts of the following projects:
with css theme 'smoothness' with css theme 'smoothness'
and some addons: slider access, timepicker and some addons: slider access, timepicker
* nestedSortable jQuery Plugin
<http://mjsarfatti.com/sandbox/nestedSortable/>
* Twitter Bootstrap * Twitter Bootstrap
<http://twitter.github.com/bootstrap/> <http://twitter.github.com/bootstrap/>
@ -24,6 +27,3 @@ OpenSlides uses parts of the following projects:
* Ubuntu TrueType Font * Ubuntu TrueType Font
<http://font.ubuntu.com/> <http://font.ubuntu.com/>
* nestedSortable jQuery Plugin
<http://mjsarfatti.com/sandbox/nestedSortable/>