From ef8e212780217c12db16a70060f57d05f58f6a07 Mon Sep 17 00:00:00 2001 From: Heikki Hokkanen Date: Mon, 2 Jun 2008 21:27:00 +0300 Subject: [PATCH] Added doc/README. Wrote description, dependencies and first installation sections. --- doc/README | 23 +++++++++++++++++++++++ doc/TODO | 3 --- 2 files changed, 23 insertions(+), 3 deletions(-) create mode 100644 doc/README diff --git a/doc/README b/doc/README new file mode 100644 index 0000000..5d37f0d --- /dev/null +++ b/doc/README @@ -0,0 +1,23 @@ +Description +=========== +ViewGit is a git web interface / repository viewer, that aims to be easy to set +up and upgrade, and light on dependencies. + +Some of the current features are: +- Project index with description, last change, tree browsing, and download links +- Project summary page with shortlog snippet and list of tags and heads (branches) +- Shortlog: date of change, author, short message, and links to commit/commitdiff/tree/download +- Commit: details of the commit +- Commitdiff: colored diff of the changes in a commit +- Tree (directory) browsing with downloadable trees (as tar/gz and zip), and downloadable files + +Dependencies +============ +- PHP 5 +- Apache or compatible web server +- Reasonably new git + +First installation +================== +- Create inc/localconfig.php and consult inc/config.php for what to put there. + diff --git a/doc/TODO b/doc/TODO index 1cdced1..ecf9677 100644 --- a/doc/TODO +++ b/doc/TODO @@ -1,9 +1,6 @@ - make sure stuff works when a commit has multiple parents (merge/octopus) - commit: show all parents -- document files and functions -- doc/README / doc/INSTALL - - concise description, dependencies, installation instructions - example config [Milestones] -- 2.11.4.GIT