From 6c0f2227bdbe78846b01b542c73e25e9c997c518 Mon Sep 17 00:00:00 2001 From: Michael Spang Date: Tue, 4 Dec 2007 22:09:17 -0500 Subject: [PATCH] Documentation updates --- docs/BUGS | 8 -------- docs/GIT-HOWTO | 10 ++-------- docs/INSTALLING | 21 ++++++++++----------- 3 files changed, 12 insertions(+), 27 deletions(-) delete mode 100644 docs/BUGS diff --git a/docs/BUGS b/docs/BUGS deleted file mode 100644 index edd2867..0000000 --- a/docs/BUGS +++ /dev/null @@ -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 diff --git a/docs/GIT-HOWTO b/docs/GIT-HOWTO index ceb739f..44cd629 100644 --- a/docs/GIT-HOWTO +++ b/docs/GIT-HOWTO @@ -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 -------------- diff --git a/docs/INSTALLING b/docs/INSTALLING index 53068b2..049f7a2 100644 --- a/docs/INSTALLING +++ b/docs/INSTALLING @@ -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.