Updated INSTALL and README for 1.3 release.

Use 'openslides' command instead of 'python start.py' for Linux/MacOS install instruction.
This commit is contained in:
Emanuel Schuetze 2012-12-10 20:29:00 +01:00
parent 56a5778260
commit 8f369ed71c
2 changed files with 22 additions and 23 deletions

View File

@ -87,21 +87,21 @@ II. Installation on GNU/Linux and MacOSX using the sources
$ sudo apt-get install git $ sudo apt-get install git
$ git clone git://github.com/OpenSlides/OpenSlides.git OpenSlides $ git clone git://github.com/OpenSlides/OpenSlides.git OpenSlides
3. Setup a virtual environment with virtualenv: 3. Setup a virtual environment with virtualenv (optional):
Go to the (extracted/cloned) root directory of OpenSlides You can setup a virtual environment to install OpenSlides as
and create virtualenv environment: non-root user.
E. g. for Ubuntu run:
$ sudo apt-get install python-virtualenv
To setup and activate the virtual environment go to the
(extracted/cloned) root directory of OpenSlides and run:
$ virtualenv .venv $ virtualenv .venv
For virtualenv >= 1.7 use instead:
$ virtualenv --system-site-packages .venv
4. Activate the virtual environment:
$ source .venv/bin/activate $ source .venv/bin/activate
5. Install the required python-packages: 4. Install the required python-packages:
$ pip install django django-mptt $ pip install django django-mptt
@ -111,7 +111,7 @@ II. Installation on GNU/Linux and MacOSX using the sources
If requirements reportlab or PIL still missing (see 1.): If requirements reportlab or PIL still missing (see 1.):
$ pip install reportlab pil $ pip install reportlab pil
6. 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
@ -124,7 +124,7 @@ II. Installation on GNU/Linux and MacOSX using the sources
Use 'python start.py --help' to show all start options. Use 'python start.py --help' to show all start options.
7. 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 (see 4.) before starting the server (see 6.).

View File

@ -2,13 +2,13 @@
English README file for OpenSlides English README file for OpenSlides
================================== ==================================
This is OpenSlides, version 1.3-rc1 (2012-11-27). This is OpenSlides, version 1.3 (2012-12-10).
What is OpenSlides? What is OpenSlides?
=================== ===================
OpenSlides is a free, web-based presentation system for displaying and OpenSlides is a free web-based presentation and assembly system for
controlling of agenda, applications and elections of an assembly. displaying and controlling of agenda, motions and elections of an assembly.
See http://openslides.org for more information. See http://openslides.org for more information.
@ -24,8 +24,9 @@ list or read the OpenSlides manual. See http://openslides.org.
The start script of OpenSlides The start script of OpenSlides
============================== ==============================
Simply running Simply running
openslides.exe (on Windows) or openslides.exe (on Windows)
python start.py (on Linux/MacOS) or
openslides (on Linux/MacOS)
will start OpenSlides using djangos development server. It will also will start OpenSlides using djangos development server. It will also
try to open OpenSlides in your default webbrowser. try to open OpenSlides in your default webbrowser.
@ -69,16 +70,14 @@ The following command line options are available:
--no-reload --no-reload
Does not reload the development server Does not reload the development server
--version
Show version and exit.
Example 1: Openslides should only be accessible on this computer: Example 1: Openslides should only be accessible on this computer:
openslides.exe -a 127.0.0.1 openslides -a 127.0.0.1
or
python start.py -a 127.0.0.1
Example 2: Like above, but also specify the port as 8080 Example 2: Like above, but also specify the port as 8080
openslides.exe -a 127.0.0.01 -p 8080 openslides -a 127.0.0.01 -p 8080
or
python start.py -a 127.0.0.1 -p 8080
Supported operating systems and browsers Supported operating systems and browsers