Go to file
Norman Jäckel 589c209c79 Merge branch 'master' into Version_String
Conflicts:
	openslides/__init__.py
	openslides/config/views.py
2012-11-28 17:54:29 +01:00
docs Doc: Prepared manual for publishing. 2012-07-25 17:12:03 +02:00
extras Fixed file name and path to renamed groups_de.json file. 2012-11-27 22:31:41 +01:00
openslides Merge branch 'master' into Version_String 2012-11-28 17:54:29 +01:00
tests Added more tests for the agenda 2012-11-26 10:05:51 +01:00
.coveragerc reordered the tests 2012-11-24 15:00:17 +01:00
.gitattributes Fixed folder list for .gitattributes. 2012-10-31 09:06:56 +01:00
.gitignore removed the tests package from the distribution 2012-11-25 00:19:38 +01:00
.travis.yml fixed pep8 in pdf.py 2012-11-26 10:35:29 +01:00
AUTHORS Added extra line 2012-11-27 22:55:41 +01:00
CHANGELOG Updated Changlog for 1.3 release. 2012-11-27 20:09:30 +01:00
INSTALL.txt Updated INSTALL to install OpenSlides via Python Package Index (PyPI) 2012-11-27 22:05:06 +01:00
LICENSE changle end of line to windows for some files 2012-07-20 10:55:07 +02:00
manage.py fixed main.py and manage.py for the openslides.exe 2012-11-09 09:51:10 +01:00
MANIFEST.in Load groups_de when creating the database 2012-11-25 01:07:39 +01:00
README.txt Prepared 1.3-rc1 release. 2012-11-27 20:13:18 +01:00
requirements.txt Changed pil to PIL in requirements 2012-11-24 16:51:21 +01:00
setup.py Include the README.txt as long-description into the distribution 2012-11-25 00:28:41 +01:00
start.py changed the main script 2012-08-14 14:19:59 +02:00
THANKS changle end of line to windows for some files 2012-07-20 10:55:07 +02:00

==================================
English README file for OpenSlides
==================================

This is OpenSlides, version 1.3-rc1 (2012-11-27).


What is OpenSlides?
===================
OpenSlides is a free, web-based presentation system for displaying and
controlling of agenda, applications and elections of an assembly.

See http://openslides.org for more information.


Getting started
===============
Install and start OpenSlides as described in the INSTALL.txt.

If you need help please contact the OpenSlides team on public mailing
list or read the OpenSlides manual. See http://openslides.org.


The start script of OpenSlides
==============================
Simply running
  openslides.exe (on Windows) or
  python start.py (on Linux/MacOS)

will start OpenSlides using djangos development server. It will also
try to open OpenSlides in your default webbrowser.

The server will listen on the IP address of your current hostname on
port 80 (if port 80 is not available port 8000 will be used).
This means that the server will be available to everyone on your
local network (at least for commonly used network configurations).

See `Command line options` below if you need to change this.

The login for the default admin user after (created on first start),
is as follows:

  Username: admin
  Password: admin


Command line options
--------------------
The following command line options are available:

-h, --help
    Shows all options

-a, --address=ADDRESS
    Changes the address on which the server will listen for connections

-p PORT, --port=PORT
    Changes the port on which the server will listen for connections

--syncdb
    Creates/updates database before starting the server

--reset-admin
    Resets the password to 'admin' for user 'admin'

-s SETTINGS, --settings=SETTINGS
    Sets the path to the settings file.

--no-reload
    Does not reload the development server


Example 1: Openslides should only be accessible on this computer:
  openslides.exe -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
  openslides.exe -a 127.0.0.01 -p 8080
  or
  python start.py -a 127.0.0.1 -p 8080


Supported operating systems and browsers
========================================
Operating Systems (OpenSlides runs anywhere where Pyhton is running):
  Windows XP or newer (32 and 64bit)
  MacOS X
  GNU/Linux

Browsers:
  Firefox 3.6+
  IE 7+
  Chrome
  Safari