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