From df8b3a98b7236f5b792ec3ff491cb4aee70551f5 Mon Sep 17 00:00:00 2001 From: Emanuel Schuetze Date: Fri, 27 Apr 2012 22:33:40 +0200 Subject: [PATCH] #117: Updated win32 readme and howto files. --- extras/win32-portable/README.txt.in | 146 ++++++++++++---------- extras/win32-portable/create_portable.txt | 26 ++-- extras/win32-portable/prepare_portable.py | 3 +- 3 files changed, 98 insertions(+), 77 deletions(-) diff --git a/extras/win32-portable/README.txt.in b/extras/win32-portable/README.txt.in index e08e4cf53..ed9d042f4 100644 --- a/extras/win32-portable/README.txt.in +++ b/extras/win32-portable/README.txt.in @@ -1,64 +1,82 @@ - -**XXX** Maybe add an introduction section (what is openslides, link to homepage, etc.)? -**XXX** Add a note that openslides should only be run on trusted networks - -Getting started -=============== -Simply running openslides.exe 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: - --a, --address=ADDRESS - Changes the address on which the server will listen for connections - --p, --port - Changes the port on which the server will listen for connections - ---syncdb - Create/ update the database - ---reset-admin - This will reset the password of the user - -Example 1: Openslides should only be accessible on this computer: - openslides.exe -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 - - -Supported operating systems and browsers -======================================== -Windows XP or newer (32 and 64bit) -**TODO** browsers - - -Included Packages -================= -${PACKAGE_LIST} - - -License -======= -openslides is distributed under the GNU General Public License -version 2. For details about this license and the licenses of the -bundled packages, please refer to the corresponding file in the -licenses/ directory. + English README file for OpenSlides + ================================== + +This is OpenSlides, version ${VERSION}. + + +What is OpenSlides? +=================== +OpenSlides is a free, web-based presentation system for displaying and +controlling of agendas, applications and elections of an event. + +See http://www.openslides.org for more information. + + +Getting started +=============== +Simply running openslides.exe 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: + +-a, --address=ADDRESS + Changes the address on which the server will listen for connections + +-p, --port + Changes the port on which the server will listen for connections + +--syncdb + Create/ update the database + +--reset-admin + This will reset the password of the user + +Example 1: Openslides should only be accessible on this computer: + openslides.exe -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 + + +Supported operating systems and browsers +======================================== +Operating Systems: + Windows XP or newe r (32 and 64bit) [use openslids.exe] + MacOS X + GNU/Linux + +Browsers: + Firefox 3.6+ + IE 7+ + Chrome + Safari + + +Included Packages +================= +${PACKAGE_LIST} + + +License +======= +OpenSlides is distributed under the GNU General Public License +version 2. For details about this license and the licenses of the +bundled packages, please refer to the corresponding file in the +licenses/ directory. diff --git a/extras/win32-portable/create_portable.txt b/extras/win32-portable/create_portable.txt index 2054e0d10..f15d27950 100644 --- a/extras/win32-portable/create_portable.txt +++ b/extras/win32-portable/create_portable.txt @@ -1,12 +1,14 @@ -How to create a new portable windows distribution of openslides: ----------------------------------------------------------------- -1.) Follow the openslides installation instructions for windows, but add - the option "-Z" when executing easy_install e.g.: - easy_install -Z django django-mptt reportlab pil - -2.) in the main directory of the openslides checkout execute: - python extras/win32-portable/prepare_portable.py - - -3.) The portable openslides distribution is now ready as a zip in the dist/ - directory +How to create a new portable Windows distribution of OpenSlides: +---------------------------------------------------------------- + +1.) Follow the OpenSlides installation instructions for windows, + but add the option "-Z" when executing easy_install, e.g.: + + easy_install -Z django django-mptt reportlab pil + +2.) In the main directory of the OpenSlides checkout execute: + + python extras/win32-portable/prepare_portable.py + +3.) The portable OpenSlides distribution is now ready as a zip in the + 'dist/' directory diff --git a/extras/win32-portable/prepare_portable.py b/extras/win32-portable/prepare_portable.py index bef9b89c8..0dc5d88f6 100644 --- a/extras/win32-portable/prepare_portable.py +++ b/extras/win32-portable/prepare_portable.py @@ -270,7 +270,8 @@ def write_readme(template_file, outfile): dist = pkg_resources.get_distribution(pkg) packages.append("{0}-{1}".format(dist.project_name, dist.version)) - tmpl_vars = {"PACKAGE_LIST": "\n".join(packages)} + tmpl_vars = {"PACKAGE_LIST": "\n".join(packages), + "VERSION": openslides.get_version()} with open(outfile, "w") as f: f.write(tmpl.substitute(tmpl_vars))