updating readme

moving directories to temp folder updating config to point to git-php folder as the $repo_directory
bholtsclaw · Sep 25, 2009 · 6f19e59 · 6f19e59
1 parent 55e99a9
commit 6f19e59
Show file tree

Hide file tree

Showing 5 changed files with 14 additions and 12 deletions.
diff --git a/.temp/bundles/empty b/.temp/bundles/empty
diff --git a/.temp/cache/empty b/.temp/cache/empty
diff --git a/.temp/secrets/empty b/.temp/secrets/empty
diff --git a/README.markdown b/README.markdown
@@ -1,24 +1,26 @@
-# Summary
-This is only a rough unsorted collection of informations. The original git-php had no README at all :-(
+# Git-PHP
 
-### Requirements
+## Summary
+Git-PHP is a port of gitweb to PHP. It includes various functionality, such as submitting diffs, repository browsing, simple search, and diff highlighting. It is based upon Zack Bartel and Peeter Vois's original work, with updates to handle the latest git installs (1.6.4.4 as September 25, 2009), as well an update to the stylesheet to make it feel more like github.com. It definitely still needs tender love and care to make it more MVC like, but it'll get there. Please read the commit messages for more information on changes implemented.
+
+## Requirements
 * git
 * enscript
 
 
-### Installation
+## Installation
 1.  edit config.php
 2.  In a terminal window, change directories to your $repo_directory and execute the following:
-    *  ```mkdir .cache .bundles .secrets ; chmod -R 777 .cache .bundles .secrets```
+    *  ```mkdir .temp/cache .temp/bundles .temp/secrets ; chmod -R 777 .cache .bundles .secrets```
 
 ### Supposed directory structure:
 	$repo_directory-\
 			|
-			+-$cache_name
+			+-./temp/$cache_name
 			|
-			+-$secret_name
+			+-./temp/$secret_name
 			|
-			+-$bundle_name
+			+-./temp/$bundle_name
 			|
 			+-project1 / .git
 			|

diff --git a/config.php b/config.php
@@ -23,7 +23,7 @@
 	$repo_index = "index.aux";
 
 /* The directory where repo directories resist */
-	$repo_directory = "/var/git/repositories/";
+	$repo_directory = dirname(__FILE__) . "/";
 
 /* The suffix, that can be used for complementing the repo directory,
  * useful when you are using nonbare repositories, then:
@@ -34,9 +34,9 @@
 /* The date format to show the dates of commits */
 	$git_date_format = 'd.m.Y (H:i)';
 
-	$cache_name = ".cache/";
-	$secret_name = ".secrets/";
-	$bundle_name = ".bundles/";
+	$cache_name = "./temp/cache/";
+	$secret_name = "./temp/secrets/";
+	$bundle_name = "./temp/bundles/";
 	$cache_directory = "{$repo_directory}{$cache_name}";
 
 	$repo_http_relpath = "/git-php/";