Merge branch 'jc/read-tree-df' (early part)
[gitweb.git] / README
diff --git a/README b/README
index 3014d7320bcc5412447070c5a5eacf0d25317eb8..548142c327a6790ff8821d67c2ee1eff7a656b52 100644 (file)
--- a/README
+++ b/README
@@ -1,16 +1,46 @@
-GIT web Interface
+////////////////////////////////////////////////////////////////
 
-The one working on:
-  http://www.kernel.org/git/
+       GIT - the stupid content tracker
 
-Get the gitweb.cgi by ftp:
-  ftp://ftp.kernel.org/pub/software/scm/gitweb/
+////////////////////////////////////////////////////////////////
 
-It reqires the git-core binaries installed on the system:
-  http://www.kernel.org/git/?p=git/git.git;a=summary
+"git" can mean anything, depending on your mood.
 
-The gitweb repository is here:
-  http://www.kernel.org/git/?p=git/gitweb.git;a=summary
+ - random three-letter combination that is pronounceable, and not
+   actually used by any common UNIX command.  The fact that it is a
+   mispronunciation of "get" may or may not be relevant.
+ - stupid. contemptible and despicable. simple. Take your pick from the
+   dictionary of slang.
+ - "global information tracker": you're in a good mood, and it actually
+   works for you. Angels sing, and a light suddenly fills the room.
+ - "goddamn idiotic truckload of sh*t": when it breaks
 
-Any comment/question/concern to:
-  Kay Sievers <kay.sievers@vrfy.org>
+Git is a fast, scalable, distributed revision control system with an
+unusually rich command set that provides both high-level operations
+and full access to internals.
+
+Git is an Open Source project covered by the GNU General Public License.
+It was originally written by Linus Torvalds with help of a group of
+hackers around the net. It is currently maintained by Junio C Hamano.
+
+Please read the file INSTALL for installation instructions.
+See Documentation/tutorial.txt to get started, then see
+Documentation/everyday.txt for a useful minimum set of commands,
+and "man git-commandname" for documentation of each command.
+CVS users may also want to read Documentation/cvs-migration.txt.
+
+Many Git online resources are accessible from http://git.or.cz/
+including full documentation and Git related tools.
+
+The user discussion and development of Git take place on the Git
+mailing list -- everyone is welcome to post bug reports, feature
+requests, comments and patches to git@vger.kernel.org. To subscribe
+to the list, send an email with just "subscribe git" in the body to
+majordomo@vger.kernel.org. The mailing list archives are available at
+http://marc.theaimsgroup.com/?l=git and other archival sites.
+
+The messages titled "A note from the maintainer", "What's in
+git.git (stable)" and "What's cooking in git.git (topics)" and
+the discussion following them on the mailing list give a good
+reference for project status, development direction and
+remaining tasks.