comparison README.txt @ 207:0a7d06e3f0fd

Remove the wrapper scripts (now taken care of by setuptools/easy_install) and update the docs to reflect the name change.
author cmlenz
date Mon, 19 Sep 2005 20:30:13 +0000
parents 8f5f772c70b0
children 7429be6b5720
comparison
equal deleted inserted replaced
206:5bd9b37a394d 207:0a7d06e3f0fd
26 Installation 26 Installation
27 ------------ 27 ------------
28 28
29 Bitten is written in Python, so make sure that you have Python installed. 29 Bitten is written in Python, so make sure that you have Python installed.
30 You'll need Python 2.3 or later. Also, make sure that setuptools 30 You'll need Python 2.3 or later. Also, make sure that setuptools
31 (http://peak.telecommunity.com/DevCenter/setuptools) is installed. 31 (http://peak.telecommunity.com/DevCenter/setuptools), version 0.6a2 or later,
32 is installed.
32 33
33 If that's taken care of, you just need to download and unpack the Bitten 34 If that's taken care of, you just need to download and unpack the Bitten
34 distribution, and execute the command: 35 distribution, and execute the command:
35 36
36 $ python setup.py install 37 $ python setup.py install
50 web interface, or just the build slave. In the latter case, you're already 51 web interface, or just the build slave. In the latter case, you're already
51 done. You might need to install software that the build of your project 52 done. You might need to install software that the build of your project
52 requires, but the Bitten build slave itself doesn't require anything extra. 53 requires, but the Bitten build slave itself doesn't require anything extra.
53 54
54 For the build master and web interface, you'll need to install Trac 0.9 55 For the build master and web interface, you'll need to install Trac 0.9
55 beta 1 and Berkeley DB XML >= 2.1.x 56 beta 2. Please refer to the Trac documentation for information on how it is
56 (http://www.sleepycat.com/products/xml.shtml), as well as their respective 57 installed.
57 dependencies. Please refer to the documentation of those projects for
58 information how they are installed.
59 58
60 59
61 Build Master Configuration 60 Build Master Configuration
62 -------------------------- 61 --------------------------
63 62
64 Once Bitten, Trac and BDB XML are installed and working, you'll have to 63 Once both Bitten and Trac are installed and working, you'll have to introduce
65 introduce Bitten to your Trac project environment. If you don't have a 64 Bitten to your Trac project environment. If you don't have a Trac project
66 Trac project set up yet, you'll need to do so in order to use Bitten. 65 set up yet, you'll need to do so in order to use Bitten.
67 66
68 If you already have a Trac project environment, the Trac web interface 67 If you already have a Trac project environment, the Trac web interface
69 will inform you with an error message that the environment needs to be 68 will inform you with an error message that the environment needs to be
70 upgraded. To do this, run: 69 upgraded. To do this, run:
71 70
90 89
91 Running the Build Master 90 Running the Build Master
92 ------------------------ 91 ------------------------
93 92
94 At this point, you're ready to start the Bitten build master. The 93 At this point, you're ready to start the Bitten build master. The
95 installation of Bitten should have put a `bittend` script on your path. 94 installation of Bitten should have put a `bitten-master` executable on your
96 If the script is not on your path, look for it in the `bin` or `scripts` 95 path. If the script is not on your path, look for it in the `bin` or
97 subdirectory of your Python installation. 96 `scripts` subdirectory of your Python installation.
98 97
99 To find out about the options and arguments of the script, execute it with 98 To find out about the options and arguments of the master, execute it with
100 the `--help` option as follows: 99 the `--help` option as follows:
101 100
102 $ bittend --help 101 $ bitten-master --help
103 102
104 Most commonly, you'll want to specify the log level and log file, as well as 103 Most commonly, you'll want to specify the log level and log file, as well as
105 the path to the Trac environment: 104 the path to the Trac environment:
106 105
107 $ bittend --verbose --log=/var/log/bittend /var/trac/myproject 106 $ bitten-master --verbose --log=/var/log/bittend /var/trac/myproject
108 107
109 108
110 Running the Build Slave 109 Running the Build Slave
111 ----------------------- 110 -----------------------
112 111
113 The build slave can be run on any machine that can connect to the machine 112 The build slave can be run on any machine that can connect to the machine
114 on which the build master is running. Just as with the build master script, 113 on which the build master is running. Just as with the build master, you
115 you should find the build slave script on your path after the installation. 114 should find the build slave executable on your path after the installation.
116 The build slave script is called `bitten`. 115 The executable file is called `bitten-slave`.
117 116
118 To get a list of options for the build slave, execute it with the `--help` 117 To get a list of options for the build slave, execute it with the `--help`
119 option: 118 option:
120 119
121 $ bitten --help 120 $ bitten-slave --help
122 121
123 To run the build slave against a slave installed on myproject.example.org, 122 To run the build slave against a slave installed on myproject.example.org,
124 you'd run: 123 you'd run:
125 124
126 $ bitten myproject.example.org 125 $ bitten-slave myproject.example.org
127 126
128 127
129 More Information 128 More Information
130 ---------------- 129 ----------------
131 130
Copyright (C) 2012-2017 Edgewall Software