blob: cb56921fc471e9754e23f654e789313d063733de [file] [log] [blame]
rscf305dff2003-10-13 17:18:52 +00001This is a port of some Plan 9 libraries and programs to Unix.
2
3Some parts expect that the tree is installed in /usr/local/plan9.
4Most are position independent. The few hard-coded references
5(there's one in sam) should really be fixed.
6
7* Obtaining the source
8
rsc771ff2b2003-10-13 18:11:43 +00009Tarballs will be posted nightly (but only when there are updates!) at
rscf305dff2003-10-13 17:18:52 +000010
11 http://pdos.lcs.mit.edu/~rsc/software/plan9
12
13/usr/local/plan9 is the suggested location to keep the software.
14All the paths in the tarball begin with plan9/, so it's okay to unpack it
15directly in /usr/local.
16
17You can use CVS to obtain the very latest version and stay up-to-date.
18See below.
19
20* Building
21
rsc21a17ff2003-11-25 02:54:24 +000022To build, cd into src and run make; mk install. This will place binaries
23in "bin". At time of writing, the commands are sam, samterm, rc, and mk.
rscf305dff2003-10-13 17:18:52 +000024There are a few shell scripts already included in bin -- B, Bwait,
25and samsave.
26
rsc21a17ff2003-11-25 02:54:24 +000027The "make" builds mk. Mk builds the rest.
rscf305dff2003-10-13 17:18:52 +000028
29* Helping out
30
31If you'd like to help out, great!
32
33The TODO file contains our (somewhat long) to do list.
34
35If you port this code to other architectures, please share your changes
36so others can benefit. See PORTING for some notes.
37
38Please use diff -u or CVS (see below) to prepare patches.
39
40* CVS
41
42You can use CVS to keep your local copy up-to-date as we make
43changes and fix bugs. The idioms explained here are pretty much
44all you need to know about CVS.
45
46To check out from the anonymous CVS repository, use
47
48 cd /usr/local
49 >$HOME/.cvspass
50 cvs -d :pserver:anoncvs@cvs.pdos.lcs.mit.edu:/cvs login
51 cvs -d :pserver:anoncvs@cvs.pdos.lcs.mit.edu:/cvs checkout plan9
52
53When prompted for a password, just hit enter.
54
55From then on, when you want to update, you can do
56
57 cd /usr/local/plan9
58 cvs update -dAP
59
60If there are conflicts between changes you have made locally
61and changes on the server, cvs will warn about them and leave
62them clearly marked in the updated files.
63
64If you change something and want to submit the change (please do!),
65you can run
66
67 cd /usr/local/plan9
68 cvs diff -u
69
70to generate the diff in a format that will be easy to apply.
71(You can also use this to see what you've changed.)
72
73Running the cvs commands in /usr/local/plan9 makes them
74apply to the whole tree. Running them in a subdirectory applies
75only to the code rooted there in the code.
76
77There's not much magical about /usr/local/plan9. If you
78check out the tree in some other directory, it should work
79just as well.
80
81Thanks.
82
83Russ Cox <rsc@swtch.com>