Documentation updates

master
Michael Spang 15 years ago
parent 28e860abca
commit 6c0f2227bd
  1. 8
      docs/BUGS
  2. 10
      docs/GIT-HOWTO
  3. 21
      docs/INSTALLING

@ -1,8 +0,0 @@
Bugs and Caveats
================
CEO:
- curses does not draw borders/lines correctly in a screen session. screen apparently ignores
some font-changing characters. workaround should be possible (other progs work).
- the menu is not redrawn between windows and therefore a gap tends to grow there

@ -11,15 +11,9 @@ When you check out the sources, you will get the entire history along with
the latest version. You do not need any special permissions to clone a
repository and start making changes.
To retrieve the ceo sources, type:
git clone /users/git/mspang/csc.git
This will give you the latest copy of mspang's source tree. Once cloned,
the repository is independent from the original and collaboration is done
by "pulling" changes. There may be other repositories to clone from in the
future.
To retrieve the ceo sources, clone the public repository:
git clone /users/git/public/pyceo.git
Making Changes
--------------

@ -9,15 +9,9 @@ can safely skip it.
Building the Package
--------------------
To build a Debian package out of the sources, run one of the following
commands at the top of the source tree:
A. debuild
B. dpkg-buildpackage -rfakeroot
C. git-buildpackage
It doesn't matter which, so 'debuild' is probably easiest. If all goes well,
a Debian package and source tarball will appear in the parent directory.
To build a Debian package out of the sources, run `debuild` at the top
of the source tree. If all goes well, a Debian package and source tarball
will appear in the parent directory.
Do NOT build the package as root (rather, don't build anything as root in
general). Use 'fakeroot' so that the permissions in the .deb can be set
@ -61,8 +55,7 @@ To install the package:
5. Build the package
Use 'debuild' or 'fakeroot dpkg-buildpackage -us -uc' to build the
package.
Use 'debuild' to build the package.
5. Install the package
@ -74,6 +67,12 @@ To install the package:
and a .dsc. Save these to a safe place (preferably in /users/git
so other can find them easily).
7. Push to /users/git/public/pyceo.git
This is a convenient hub for pushing/pulling between contributors.
You must be in the 'git' group to do this - if you're able to install
the package you will certainly be able to add yourself to this group.
If everyone follows these steps, every installed version will be a
descendant of the previous. Further, since old versions are archived it
will be easy to quickly get ceo working again after a bad update.

Loading…
Cancel
Save