annotate BUILD.txt @ 184:a6e630048eb4

Added the 'clean' command to the instructions distutils doesn't seem to always detect when it needs to rebuild when it should.
author Richard Jones <richard@users.sourceforge.net>
date Thu, 02 Aug 2001 01:00:39 +0000
parents c9ac428156ec
children 30c3a37b699f
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
98
16dcdab5ce70 Added build instructions...
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1 Roundup
16dcdab5ce70 Added build instructions...
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2 =======
16dcdab5ce70 Added build instructions...
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
3
16dcdab5ce70 Added build instructions...
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
4 This software is released under the GNU GPL. The copyright is held by Bizar
16dcdab5ce70 Added build instructions...
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
5 Software Pty Ltd (http://www.bizarsoftware.com.au).
16dcdab5ce70 Added build instructions...
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
6
16dcdab5ce70 Added build instructions...
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
7 The stylesheet included with this package has been copied from the Zope
16dcdab5ce70 Added build instructions...
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
8 management interface and presumably belongs to Digital Creations.
16dcdab5ce70 Added build instructions...
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
9
16dcdab5ce70 Added build instructions...
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
10
16dcdab5ce70 Added build instructions...
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
11 1. Building Releases
16dcdab5ce70 Added build instructions...
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
12 ====================
16dcdab5ce70 Added build instructions...
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
13
16dcdab5ce70 Added build instructions...
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
14 Roundup is currently a source-only release - it has no binary components. I
16dcdab5ce70 Added build instructions...
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
15 want it to stay that way, too.
16dcdab5ce70 Added build instructions...
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
16
16dcdab5ce70 Added build instructions...
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
17 This means that we only need to ever build source releases. This is done by
16dcdab5ce70 Added build instructions...
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
18 running:
16dcdab5ce70 Added build instructions...
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
19
184
a6e630048eb4 Added the 'clean' command to the instructions
Richard Jones <richard@users.sourceforge.net>
parents: 99
diff changeset
20 0. python setup.py clean --all
98
16dcdab5ce70 Added build instructions...
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
21 1. Edit setup.py to ensure that all information therein (version, contact
16dcdab5ce70 Added build instructions...
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
22 information etc) is correct.
184
a6e630048eb4 Added the 'clean' command to the instructions
Richard Jones <richard@users.sourceforge.net>
parents: 99
diff changeset
23 2. python setup.py sdist --manifest-only
98
16dcdab5ce70 Added build instructions...
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
24 3. Check the MANIFEST to make sure that any new files are included. If
16dcdab5ce70 Added build instructions...
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
25 they are not, edit MANIFEST.in to include them. "Documentation" for
16dcdab5ce70 Added build instructions...
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
26 MANIFEST.in may be found in disutils.filelist._parse_template_line.
99
c9ac428156ec minor notes
Richard Jones <richard@users.sourceforge.net>
parents: 98
diff changeset
27 4. python setup.py sdist
184
a6e630048eb4 Added the 'clean' command to the instructions
Richard Jones <richard@users.sourceforge.net>
parents: 99
diff changeset
28 (if you find sdist a little verbose, add "--quiet" to the end of the
a6e630048eb4 Added the 'clean' command to the instructions
Richard Jones <richard@users.sourceforge.net>
parents: 99
diff changeset
29 command)
98
16dcdab5ce70 Added build instructions...
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
30 5. FTP the tar.gz from the dist directory to to the "incoming" directory on
16dcdab5ce70 Added build instructions...
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
31 "upload.sourceforge.net".
16dcdab5ce70 Added build instructions...
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
32 6. Make a quick release at:
16dcdab5ce70 Added build instructions...
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
33 http://sourceforge.net/project/admin/qrs.php?package_id=&group_id=31577
16dcdab5ce70 Added build instructions...
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
34
184
a6e630048eb4 Added the 'clean' command to the instructions
Richard Jones <richard@users.sourceforge.net>
parents: 99
diff changeset
35 So, those commands in a nice, cut'n'pasteable form :)
a6e630048eb4 Added the 'clean' command to the instructions
Richard Jones <richard@users.sourceforge.net>
parents: 99
diff changeset
36 python setup.py clean --all
a6e630048eb4 Added the 'clean' command to the instructions
Richard Jones <richard@users.sourceforge.net>
parents: 99
diff changeset
37 python setup.py sdist --manifest-only
a6e630048eb4 Added the 'clean' command to the instructions
Richard Jones <richard@users.sourceforge.net>
parents: 99
diff changeset
38 python setup.py sdist --quiet
98
16dcdab5ce70 Added build instructions...
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
39
16dcdab5ce70 Added build instructions...
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
40
16dcdab5ce70 Added build instructions...
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
41 2. Author
16dcdab5ce70 Added build instructions...
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
42 =========
16dcdab5ce70 Added build instructions...
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
43 richard@sourceforge.net
16dcdab5ce70 Added build instructions...
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
44

Roundup Issue Tracker: http://roundup-tracker.org/