Changeset 5768 for main/waeup.sirp/trunk


Ignore:
Timestamp:
15 Feb 2011, 08:47:13 (14 years ago)
Author:
Henrik Bettermann
Message:

Remove duplicate installation instructions from README.txt. They should only be in INSTALL.txt.

Remove the Building Docs section in INSTALL.txt. There is a special section which describes this.

The waeup.sirp string should be consitently italic.

Location:
main/waeup.sirp/trunk
Files:
2 edited

Legend:

Unmodified
Added
Removed

  • main/waeup.sirp/trunk/README.txt

    r5495 r5768  
    1 waeup.sirp
    2 **********
     1What is `waeup.sirp`?
     2*********************
    33
    44The WAeUP Student Information and Registration Portal. `waeup.sirp` is
    55a web-based management tool for managing universities and schools.
    66
    7 What is ``waeup.sirp``?
    8 =======================
    9 
    107The package was created as an effort of the WAeUP group. See
    118http://www.waeup.org to learn more about WAeUP.
    129
    13 
    14 Installation
    15 ============
    16 
    17 .. note:: ``waeup.sirp`` might not work with Python > 2.5
    18           currently. Use of Python 2.5 is recommended.
    19 
    20 .. note:: ``waeup.sirp`` does not work on Windows.
    21 
    22 Prerequisites
    23 -------------
    24 
    25 The ``waeup.sirp`` package is based on `Grok`_, which is a Python
    26 framework for agile webapplication development. Grok itself is based
    27 on `Zope`_.
    28 
    29 .. _Grok: http://grok.zope.org/
    30 
    31 .. _Zope: http://www.zope.org/
    32 
    33 Both, Grok and Zope, are written in Python (with parts written in
    34 C). You therefore need `Python`_ installed.
    35 
    36 .. _Python: http://www.python.org/
    37 
    38 Note, that you also need the Python header files and a compiler to
    39 compile the parts written in C.
    40 
    41 To deploy ``waeup.sirp`` most easily, we use `zc.buildout`_
    42 
    43 .. _zc.buildout: http://cheeseshop.python.org/pypi/zc.buildout
    44 
    45 You may have setuptools already installed for your system Python. In
    46 that case, you may need to upgrade it first because buildout requires
    47 a very recent version::
    48 
    49     $ sudo easy_install -U setuptools
    50 
    51 If this command fails because easy_install is not available, there is
    52 a good chance you do not have setuptools available for your system
    53 Python. If so, there is no problem because setuptools will be
    54 installed locally by buildout.
    55 
    56 Bootstrap the buildout environment::
    57 
    58     $ python2.5 bootstrap/bootstrap.py
    59 
    60 and run the buildout command::
    61 
    62     $ bin/buildout
    63     [lots of stuff will be downloaded and installed here]
    64 
    65 Note that if you have more than one sandbox for a Zope-based web
    66 application, it will probably make sense to share the eggs between the
    67 different sandboxes.  You can tell ``zc.buildout`` to use a central
    68 eggs directory by creating ``~/.buildout/default.cfg`` with the
    69 following contents::
    70 
    71     [buildout]
    72     eggs-directory = /home/bruno/buildout-eggs
    73 
    74 Running the ``waeup`` application
    75 ---------------------------------
    76 
    77 You can start Zope with the with the following command:
    78 
    79     $ bin/sirpctl fg
    80 
    81 Alternatively you can do:
    82 
    83     $ bin/paster serve parts/etc/deploy.ini
    84 
    85 If you now connect to port 8080 and log in with username 'grok',
    86 password 'grok', you should be able to add the grok-based applications
    87 (such as ``University``) from the menu.
    88 
    89 Add an instance of ``University`` and click on the link next to the
    90 then visible entry in the list of installed applications.
    91 
    92 Running the tests
    93 -----------------
    94 
    95 The tests are easily run by executing the test runner that's
    96 installed in the ``bin`` directory::
    97 
    98     $ bin/test
    99 
     10Installation instructions can be found in the User Documentation (docs folder in the file system).

  • main/waeup.sirp/trunk/docs/INSTALL.txt

    r5767 r5768  
    22************
    33
    4 .. note:: ``waeup.sirp`` might not work with Python > 2.5
     4.. note:: `waeup.sirp` might not work with Python > 2.5
    55          currently. Use of Python 2.5 is recommended.
    66
    7 .. note:: ``waeup.sirp`` does not work on Windows.
     7.. note:: `waeup.sirp` does not work on Windows.
    88
    99Prerequisites
    1010=============
    1111
    12 The ``waeup.sirp`` package is based on `Grok`_, which is a Python
     12The `waeup.sirp` package is based on `Grok`_, which is a Python
    1313framework for agile webapplication development. Grok itself is based
    1414on `Zope`_.
    … …  
    2626compile the parts written in C.
    2727
    28 To deploy ``waeup.sirp`` most easily, we use `zc.buildout`_
     28To deploy `waeup.sirp` most easily, we use `zc.buildout`_
    2929
    3030.. _zc.buildout: http://cheeseshop.python.org/pypi/zc.buildout
    … …  
    5959    eggs-directory = /home/bruno/buildout-eggs
    6060
    61 Running the ``waeup.sirp`` application
     61Running the `waeup.sirp` application
    6262======================================
    6363
    … …  
    8585    $ bin/test
    8686
    87 Building the docs
    88 =================
    89 
    90 To build the docs,
    91 
    92 ::
    93 
    94     $bin/waeupdocs
    95 
    96 should be sufficient.
Note: See TracChangeset for help on using the changeset viewer.