Showing 1 changed files with 29 additions and 33 deletions
+29 -33
README.md
... ...
@@ -6,12 +6,12 @@ Github clone. You can install portable github system into Unix/Linux.
6 6
 
7 7
 # Features
8 8
 
9
-* Github clone. GitPrep have same interface as GitHub.
10
-* Portable. You can install GitPrep into your Unix/Linux server.
11
-* Support cygwin on Windows(need gcc4 package). You can install GitPrep into Windows.
9
+* Github clone: GitPrep has the same interface as GitHub.
10
+* Portable: You can install GitPrep on your own Unix/Linux server.
11
+* Supports Windows installation via cygwin for Windows (need gcc4 package).
12 12
 * Only needs Perl 5.8.7+.
13
-* Smart HTTP support, you can pull and push via HTTP
14
-* CGI support, and having built-in web server, Reverse proxy support.
13
+* Smart HTTP support: you can pull and push via HTTP
14
+* CGI support, built-in web server, and reverse proxy support.
15 15
 * SSL support.
16 16
 
17 17
 # Installation into Shared Server
... ...
@@ -19,19 +19,16 @@ Github clone. You can install portable github system into Unix/Linux.
19 19
 Shared Server must support **Linux/Unix**, **Apache**, **SuExec**,
20 20
 **CGI**, and **PHP5(CGI mode)**.
21 21
 
22
-(*PHP* is not necessary, if PHP exists, the install process is easy
22
+(*PHP* is not strictly necessary. If PHP exists, the install process is easy
23 23
 because you do not need to think about permissions.)
24 24
 
25
-Many shared servers support these,
26
-so you will be able to find a suitable server easily.
25
+Many shared servers support these, so you will be able to find or setup a suitable server easily.
27 26
 
28 27
 ## Download
29 28
 
30
-First you need to download gitprep.
29
+First you need to [download gitprep](https://github.com/yuki-kimoto/gitprep/archive/latest.zip).
31 30
 
32
-https://github.com/yuki-kimoto/gitprep/archive/latest.zip
33
-
34
-Expand the zip file. You will see the following directory.
31
+Expand the zip file. You will see the following directory:
35 32
 
36 33
     gitprep-latest
37 34
 
... ...
@@ -42,7 +39,7 @@ Rename the gitprep-latest directory to gitprep.
42 39
 ## Configuration
43 40
 
44 41
 GitPrep needs the git command. You must install git by yourself.
45
-If you don't yet set user.name and user.email, you must set them.
42
+If you haven't set user.name and user.email, you must set them.
46 43
 
47 44
     git config --global user.name "gitprep"
48 45
     git config --global user.email "gitprep@example.com"
... ...
@@ -55,25 +52,24 @@ You must add the correct git command path to the **gitprep.conf** config file.
55 52
 
56 53
 ## Upload Server by FTP
57 54
 
58
-You upload these directory into server document root by FTP.
55
+You should upload these directories into server document root by FTP.
59 56
 
60 57
 ## Setup
61 58
 
62
-Access the following URL by browser.
59
+Access the following URL by browser:
63 60
 
64 61
     http://(Your host name)/gitprep/setup/setup.php
65 62
 
66
-(If you don't access PHP file or don't have PHP,
67
-you can use CGI script
68
-please set this CGI script permission to 755)
63
+If you don't access PHP file or don't have PHP,
64
+you can use CGI script. Please set this CGI script permission to `755`.
69 65
 
70
-    http://(Your host name)/gitprep/setup/setup.cgi.
66
+    http://(Your host name)/gitprep/setup/setup.cgi
71 67
 
72
-Click Setup button once and wait about 5 minutes.
68
+Click the Setup button once and wait about 5 minutes.
73 69
 
74 70
 ## Go to application
75 71
 
76
-If you see result, click "Go to Application".
72
+If you see the result screen, click "Go to Application".
77 73
 
78 74
 ## Getting started
79 75
 
... ...
@@ -89,22 +85,22 @@ Note: the admin user cannot create repos.
89 85
 
90 86
 One way to import data:
91 87
 
92
-1. Create your new repo in gitprep
93
-2. In your local git repo, add a new remote target
88
+1. Create your new repo in gitprep.
89
+2. In your local git repo, add a new remote target: 
94 90
 ```
95 91
 git remote add gitprep git@my.gitprep.server:new-repo.git 
96 92
 ```
97
-3. Push all your repo content up in to this new gitprep target
98
-4. Update your local git repo config such that gitprep is now the origin
93
+3. Push all your repo content up in to this new gitprep target.
94
+4. Update your local git repo config such that gitprep is now the origin.
99 95
 
100
-Copy from /var/lib/gitolite or /var/lib/gitosis
96
+Copy from `/var/lib/gitolite` or `/var/lib/gitosis`
101 97
 
102 98
 TBD
103 99
 
104 100
 ## Internal Server Error
105 101
 
106 102
 If you receive an internal server error, look at the log file (gitprep/log/production.log)
107
-to see what the problem occurred.
103
+to see what problem has occurred.
108 104
 
109 105
 # Installation into own Unix/Linux Server
110 106
 
... ...
@@ -114,13 +110,13 @@ This is much better than the way shown above
114 110
 because you do not need to setup the Apache environment
115 111
 and performance will be much better.
116 112
 
117
-(You can also install GitPrep into Cygwin.
113
+You can also install GitPrep into Cygwin.
118 114
 If you want to install GitPrep into Cygwin,
119
-gcc4 and make program are needed.)
115
+gcc4 and make program are needed.
120 116
 
121 117
 ## Create gitprep user
122 118
 
123
-Create a **gitprep** user. This is not necessary, but recommended.
119
+Create a **gitprep** user. This is not necessary, but recommended:
124 120
 
125 121
     useradd gitprep
126 122
     su - gitprep
... ...
@@ -128,7 +124,7 @@ Create a **gitprep** user. This is not necessary, but recommended.
128 124
 
129 125
 ## Download
130 126
 
131
-Download tar.gz archive, expand it and change directory.
127
+Download tar.gz archive, expand it and change directory:
132 128
 
133 129
     curl -kL https://github.com/yuki-kimoto/gitprep/archive/latest.tar.gz > gitprep-latest.tar.gz
134 130
     tar xf gitprep-latest.tar.gz
... ...
@@ -137,13 +133,13 @@ Download tar.gz archive, expand it and change directory.
137 133
 
138 134
 ## Setup
139 135
 
140
-To setup GitPrep, execute the following command. All of the needed modules will be installed.
136
+To setup GitPrep, execute the following command. All of the needed modules will be installed:
141 137
 
142 138
     ./setup.sh
143 139
 
144 140
 ## Test
145 141
 
146
-Run the test to check if the setup process was successful or not.
142
+Run the test to check if the setup process was successful or not:
147 143
 
148 144
     prove t
149 145