#117: Updated win32 readme and howto files.

extras/win32-portable/README.txt.in

@@ -1,64 +1,82 @@
-
+            English README file for OpenSlides
-**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
+
-
+This is OpenSlides, version ${VERSION}.
-Getting started
+
-===============
+
-Simply running openslides.exe will start openslides using djangos
+What is OpenSlides?
-development server. It will also try to open openslides in your
+===================
-default webbrowser.
+OpenSlides is a free, web-based presentation system for displaying and
-
+controlling of agendas, applications and elections of an event.
-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).
+See http://www.openslides.org for more information.
-This means that the server will be available to everyone on your
+
-local network (at least for commonly used network configurations).
+
-
+Getting started
-See `Command line options` below if you need to change this.
+===============
-
+Simply running openslides.exe will start OpenSlides using djangos
-The login for the default admin user after (created on first start),
+development server. It will also try to open OpenSlides in your
-is as follows:
+default webbrowser.
-
+
-  Username: admin
+The server will listen on the IP address of your current hostname on
-  Password: admin
+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).
-Command line options
+
-====================
+See `Command line options` below if you need to change this.
-The following command line options are available:
+
-
+The login for the default admin user after (created on first start),
--a, --address=ADDRESS
+is as follows:
-    Changes the address on which the server will listen for connections
+
-
+  Username: admin
--p, --port
+  Password: admin
-    Changes the port on which the server will listen for connections
+
-
+
---syncdb
+Command line options
-    Create/ update the database
+====================
-
+The following command line options are available:
---reset-admin
+
-    This will reset the password of the user
+-a, --address=ADDRESS
-
+    Changes the address on which the server will listen for connections
-Example 1: Openslides should only be accessible on this computer:
+
-  openslides.exe -a 127.0.0.1
+-p, --port
-
+    Changes the port on which the server will listen for connections
-Example 2: Like above, but also specify the port as 8080
+
-  openslides.exe -a 127.0.0.01 -p 8080
+--syncdb
-
+    Create/ update the database
-
+
-Supported operating systems and browsers
+--reset-admin
-========================================
+    This will reset the password of the user
-Windows XP or newer (32 and 64bit)
+
-**TODO** browsers
+Example 1: Openslides should only be accessible on this computer:
-
+  openslides.exe -a 127.0.0.1
-
+
-Included Packages
+Example 2: Like above, but also specify the port as 8080
-=================
+  openslides.exe -a 127.0.0.01 -p 8080
-${PACKAGE_LIST}
+
-
+
-
+Supported operating systems and browsers
-License
+========================================
-=======
+Operating Systems:
-openslides is distributed under the GNU General Public License
+  Windows XP or newe r (32 and 64bit) [use openslids.exe]
-version 2. For details about this license and the licenses of the
+  MacOS X
-bundled packages, please refer to the corresponding file in the
+  GNU/Linux
-licenses/ directory.
+
+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.

extras/win32-portable/create_portable.txt

@@ -1,12 +1,14 @@
-How to create a new portable windows distribution of openslides:
+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.:
+1.) Follow the OpenSlides installation instructions for windows,
-      easy_install -Z django django-mptt reportlab pil
+    but add the option "-Z" when executing easy_install, e.g.:
-
+
-2.) in the main directory of the openslides checkout execute:
+      easy_install -Z django django-mptt reportlab pil
-      python extras/win32-portable/prepare_portable.py
+
-
+2.) In the main directory of the OpenSlides checkout execute:
-
+
-3.) The portable openslides distribution is now ready as a zip in the dist/
+      python extras/win32-portable/prepare_portable.py
-    directory
+
+3.) The portable OpenSlides distribution is now ready as a zip in the
+    'dist/' directory

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))