From 294f22a4705f221b9f5cf0d8df0dc7cf7626b886 Mon Sep 17 00:00:00 2001 From: Russ Cox Date: Sun, 16 Nov 2014 21:36:20 -0500 Subject: README: rename to README.md, add markdown for github Change-Id: I2e644aa2d693692f33d017c00367a734039532f1 --- README.md | 37 +++++++++++++++++++++++++++++++++++++ 1 file changed, 37 insertions(+) create mode 100644 README.md (limited to 'README.md') diff --git a/README.md b/README.md new file mode 100644 index 00000000..8cec190c --- /dev/null +++ b/README.md @@ -0,0 +1,37 @@ +This is a port of many Plan 9 libraries and programs to Unix. + +* Installation + +To install, run ./INSTALL. It builds mk and then uses mk to +run the rest of the installation. + +For more details, see install(1), at install.txt in this directory +and at http://swtch.com/plan9port/man/man1/install.html. + +* Documentation + +See http://swtch.com/plan9port/man/ for more documentation. +(Documentation is also in this tree, but you need to run +a successful install first. After that, "9 man 1 intro".) + +Intro(1) contains a list of man pages that describe new features +or differences from Plan 9. + +* Helping out + +If you'd like to help out, great! The TODO file contains a small list. + +If you port this code to other architectures, please share your changes +so others can benefit. + +Please use diff -u or CVS (see below) to prepare patches. + +* CVS + +You can use CVS to keep your local copy up-to-date as we make +changes and fix bugs. See the cvs(1) man page here ("9 man cvs") +for details on using cvs. + +* Contact + +Russ Cox -- cgit v1.2.3