From 9d81a0b871963cdab1f1fdec80ce5ee1e27df2e8 Mon Sep 17 00:00:00 2001 From: Andy Kittner Date: Fri, 27 Apr 2012 23:29:39 +0200 Subject: [PATCH] Use README.txt for source distribution as well as for win32-portable --- .../README.txt.in => README.txt | 151 ++++++++---------- extras/win32-portable/prepare_portable.py | 30 ++-- 2 files changed, 88 insertions(+), 93 deletions(-) rename extras/win32-portable/README.txt.in => README.txt (78%) diff --git a/extras/win32-portable/README.txt.in b/README.txt similarity index 78% rename from extras/win32-portable/README.txt.in rename to README.txt index ed9d042f4..208271b93 100644 --- a/extras/win32-portable/README.txt.in +++ b/README.txt @@ -1,82 +1,69 @@ - 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. + English README file for OpenSlides + ================================== + +This is OpenSlides, version 1.2. + + +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 newer (32 and 64bit) [use openslides.exe] + MacOS X + GNU/Linux + +Browsers: + Firefox 3.6+ + IE 7+ + Chrome + Safari diff --git a/extras/win32-portable/prepare_portable.py b/extras/win32-portable/prepare_portable.py index 0dc5d88f6..c013f20f6 100644 --- a/extras/win32-portable/prepare_portable.py +++ b/extras/win32-portable/prepare_portable.py @@ -19,7 +19,6 @@ import distutils.ccompiler import distutils.sysconfig from contextlib import nested -from string import Template import pkg_resources @@ -100,6 +99,16 @@ MSVCR_PUBLIC_KEY = "1fc8b3b9a1e18e3b" MSVCR_VERSION = "9.0.21022.8" MSVCR_NAME = "Microsoft.VC90.CRT" +README_LICENSE_SECTION = """ + +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. +""" + def compile_re_list(patterns): expr = "|".join("(?:{0})".format(x) for x in patterns) return re.compile(expr) @@ -261,20 +270,19 @@ def copy_msvcr(odir): shutil.copyfile(src, dest) -def write_readme(template_file, outfile): - with open(template_file, "rU") as f: - tmpl = Template(f.read()) +def write_readme(orig_readme, outfile): + with open(orig_readme, "rU") as f: + text = [l for l in f] - packages = ["openslides-{0}".format(openslides.get_version())] - for pkg in SITE_PACKAGES: + text.extend(["\n", "\n", "Included Packages\n", 17 * "=" + "\n"]) + for pkg in sorted(SITE_PACKAGES): dist = pkg_resources.get_distribution(pkg) - packages.append("{0}-{1}".format(dist.project_name, dist.version)) + text.append("{0}-{1}\n".format(dist.project_name, dist.version)) - tmpl_vars = {"PACKAGE_LIST": "\n".join(packages), - "VERSION": openslides.get_version()} with open(outfile, "w") as f: - f.write(tmpl.substitute(tmpl_vars)) + f.writelines(text) + f.write(README_LICENSE_SECTION) def main(): @@ -312,7 +320,7 @@ def main(): zip_fp = os.path.join("dist", "openslides-{0}-portable.zip".format( openslides.get_version())) - write_readme("extras/win32-portable/README.txt.in", + write_readme("README.txt", os.path.join(odir, "README.txt")) with zipfile.ZipFile(zip_fp, "w", zipfile.ZIP_DEFLATED) as zf: