Update README.md ・ fa8900e ・ Gitprep

+41 -41

README.md

@@ -1,47 +1,47 @@
 # GitPrep
 
-Github clone. You can install portable github system into unix/linux.
+Github clone. You can install portable github system into Unix/Linux.
 
 <img src="http://cdn-ak.f.st-hatena.com/images/fotolife/p/perlcodesample/20130421/20130421180903_original.png" width="850">
 
 # Features
 
 * Github clone
-* Portable. you can install it into your Unix/Linux server.
-* Perl 5.8.7+ only needed
+* Portable. You can install it into your Unix/Linux server.
+* Only needs Perl 5.8.7+
 * CGI support
-* Having built-in web server, Reverse proxy support
+* Has built-in web server and reverse proxy support
 
 # Installation into Shared Server
 
 Shared Server must support **Linux/Unix**, **Apache**, **SuExec**,
 **CGI**, and **PHP5(CGI mode)**.
 
-(PHP is not necessary, if PHP exists, install process is easy
-because you don't need to think about permission.)
+(PHP is not necessary, if PHP exists, the install process is easy
+because you do not need to think about permissions.)
 
-Many shared server support these,
-so you will find suitable server easily.
+Many shared servers support these,
+so you will be able to find a suitable server easily.
 
 ## Download
 
-You download gitprep.
+First you need to download gitprep.
 
 https://github.com/yuki-kimoto/gitprep/archive/latest.zip
 
-You expand zip file. You see the following directory.
+Expand the zip file. You will see the following directory.
 
     gitprep-latest
 
-Rename this gitprep-latest to gitprep.
+Rename the gitprep-latest directory to gitprep.
 
     gitprep-latest -> gitprep
 
 ## Configuration
 
-GitPrep need git command. you must install git by yourself.
+GitPrep needs the git command. You must install git by yourself.
 
-and you must add git command path into config file **gitprep.conf**
+You must add the correct git command path to the **gitprep.conf** config file.
 
     [basic]
     ;;; Git command path
@@ -69,18 +69,18 @@ Click Setup button once and wait about 5 minutes.
 
 If you see result, click "Go to Application".
 
-## You see Internal Server Error
+## Internal Server Error
 
-If you see internal server error, you see gitprep/log/production.log.
-You know what error is happened.
+If you receive an internal server error, look at the log file (gitprep/log/production.log)
+to see what the problem occurred.
 
 # Installation into own Unix/Linux Server
 
-GitPrep have own web server,
-so you can execute application very easily.
-This is much better than above way
-because you don't need to setup Apache environment,
-and performance is much much better.
+GitPrep has its own web server,
+so you can start using the application very easily.
+This is much better than the way shown above
+because you do not need to setup the Apache environment
+and performance will be much better.
 
 (You can also install GitPrep into Cygwin.
 If you want to install GitPrep into Cygwin,
@@ -88,7 +88,7 @@ gcc4 and make program are needed.)
 
 ## Create gitprep user
 
-At first create **gitprep** user. This is not necessary, but recommended.
+Create a **gitprep** user. This is not necessary, but recommended.
 
     useradd gitprep
     su - gitprep
@@ -96,7 +96,7 @@ At first create **gitprep** user. This is not necessary, but recommended.
 
 ## Download
 
-Download tar.gz archive and expand it and change directory.
+Download tar.gz archive, expand it and change directory.
 
     curl -kL https://github.com/yuki-kimoto/gitprep/archive/latest.tar.gz > gitprep-latest.tar.gz
     tar xf gitprep-latest.tar.gz
@@ -105,17 +105,17 @@ Download tar.gz archive and expand it and change directory.
 
 ## Setup
 
-You execute the following command. Needed modules is installed.
+To setup GitPrep, execute the following command. All of the needed modules will be installed.
 
     ./setup.sh
 
 ## Test
 
-Do test to check setup process is success or not.
+Run the test to check if the setup process was successful or not.
 
     prove t
 
-If "All tests successful" is shown, setup process is success.
+If "All tests successful" is shown, the setup process was successful.
 
 ## Configuration
 
@@ -125,48 +125,48 @@ Same as Shared Server's Configuration section.
 
 ### Start
 
-You can start application start.
-Application is run in background, port is **10020** by default.
+You can start the application by running the provided gitprep script.
+The application is run in the background and the port is **10020** by default.
 
     ./gitprep
 
-You can access the following URL.
+Then access the following URL.
 
     http://localhost:10020
 
-If you change port, edit gitprep.conf.
-If you can't access this port, you might change firewall setting.
+If you want to change the port, edit gitprep.conf.
+If you cannot access this port, you might change the firewall settings.
 
 ### Stop
 
-You can stop application by **--stop** option.
+You can stop the application by adding the **--stop** option.
 
     ./gitprep --stop
 
 ### Operation from root user
 
-You can operation application from root user.
+You can manage the application from the root user.
 
-Start application
+Start the application
 
     sudo -u gitprep /home/gitprep/gitprep/gitprep
 
-Stop application
+Stop the application
 
     sudo -u gitprep /home/gitprep/gitprep/gitprep --stop
 
-If you want to start application when OS start,
+If you want to start the application when the OS starts,
 add the start application command to **rc.local**(Linux).
 
-If you want to make easy to manage gitprep,
-Let's create run script.
+If you want to make it easy to manage gitprep,
+then create a run script.
 
     mkdir -p /webapp
     echo '#!/bin/sh' > /webapp/gitprep
     echo 'sudo -u gitprep /home/gitprep/gitprep/gitprep $*' >> /webapp/gitprep
     chmod 755 /webapp/gitprep
 
-You can start and stop application the following command.
+You can start and stop the application with the following command.
 
     # Start or Restart
     /webapp/gitprep
@@ -176,11 +176,11 @@ You can start and stop application the following command.
 
 ## Developer
 
-If you are developer, you can start application development mode
+If you are a developer, you can start the application in development mode.
 
     ./morbo
 
-You can access the following URL.
+Then access the following URL.
 
     http://localhost:3000
 

...	...	@@ -1,47 +1,47 @@
1	1	# GitPrep
2	2
3		-Github clone. You can install portable github system into unix/linux.
	3	+Github clone. You can install portable github system into Unix/Linux.
4	4
5	5	<img src="http://cdn-ak.f.st-hatena.com/images/fotolife/p/perlcodesample/20130421/20130421180903_original.png" width="850">
6	6
7	7	# Features
8	8
9	9	* Github clone
10		-* Portable. you can install it into your Unix/Linux server.
11		-* Perl 5.8.7+ only needed
	10	+* Portable. You can install it into your Unix/Linux server.
	11	+* Only needs Perl 5.8.7+
12	12	* CGI support
13		-* Having built-in web server, Reverse proxy support
	13	+* Has built-in web server and reverse proxy support
14	14
15	15	# Installation into Shared Server
16	16
17	17	Shared Server must support Linux/Unix, Apache, SuExec,
18	18	CGI, and PHP5(CGI mode).
19	19
20		-(PHP is not necessary, if PHP exists, install process is easy
21		-because you don't need to think about permission.)
	20	+(PHP is not necessary, if PHP exists, the install process is easy
	21	+because you do not need to think about permissions.)
22	22
23		-Many shared server support these,
24		-so you will find suitable server easily.
	23	+Many shared servers support these,
	24	+so you will be able to find a suitable server easily.
25	25
26	26	## Download
27	27
28		-You download gitprep.
	28	+First you need to download gitprep.
29	29
30	30	https://github.com/yuki-kimoto/gitprep/archive/latest.zip
31	31
32		-You expand zip file. You see the following directory.
	32	+Expand the zip file. You will see the following directory.
33	33
34	34	gitprep-latest
35	35
36		-Rename this gitprep-latest to gitprep.
	36	+Rename the gitprep-latest directory to gitprep.
37	37
38	38	gitprep-latest -> gitprep
39	39
40	40	## Configuration
41	41
42		-GitPrep need git command. you must install git by yourself.
	42	+GitPrep needs the git command. You must install git by yourself.
43	43
44		-and you must add git command path into config file gitprep.conf
	44	+You must add the correct git command path to the gitprep.conf config file.
45	45
46	46	[basic]
47	47	;;; Git command path
...	...	@@ -69,18 +69,18 @@ Click Setup button once and wait about 5 minutes.
69	69
70	70	If you see result, click "Go to Application".
71	71
72		-## You see Internal Server Error
	72	+## Internal Server Error
73	73
74		-If you see internal server error, you see gitprep/log/production.log.
75		-You know what error is happened.
	74	+If you receive an internal server error, look at the log file (gitprep/log/production.log)
	75	+to see what the problem occurred.
76	76
77	77	# Installation into own Unix/Linux Server
78	78
79		-GitPrep have own web server,
80		-so you can execute application very easily.
81		-This is much better than above way
82		-because you don't need to setup Apache environment,
83		-and performance is much much better.
	79	+GitPrep has its own web server,
	80	+so you can start using the application very easily.
	81	+This is much better than the way shown above
	82	+because you do not need to setup the Apache environment
	83	+and performance will be much better.
84	84
85	85	(You can also install GitPrep into Cygwin.
86	86	If you want to install GitPrep into Cygwin,
...	...	@@ -88,7 +88,7 @@ gcc4 and make program are needed.)
88	88
89	89	## Create gitprep user
90	90
91		-At first create gitprep user. This is not necessary, but recommended.
	91	+Create a gitprep user. This is not necessary, but recommended.
92	92
93	93	useradd gitprep
94	94	su - gitprep
...	...	@@ -96,7 +96,7 @@ At first create gitprep user. This is not necessary, but recommended.
96	96
97	97	## Download
98	98
99		-Download tar.gz archive and expand it and change directory.
	99	+Download tar.gz archive, expand it and change directory.
100	100
101	101	curl -kL https://github.com/yuki-kimoto/gitprep/archive/latest.tar.gz > gitprep-latest.tar.gz
102	102	tar xf gitprep-latest.tar.gz
...	...	@@ -105,17 +105,17 @@ Download tar.gz archive and expand it and change directory.
105	105
106	106	## Setup
107	107
108		-You execute the following command. Needed modules is installed.
	108	+To setup GitPrep, execute the following command. All of the needed modules will be installed.
109	109
110	110	./setup.sh
111	111
112	112	## Test
113	113
114		-Do test to check setup process is success or not.
	114	+Run the test to check if the setup process was successful or not.
115	115
116	116	prove t
117	117
118		-If "All tests successful" is shown, setup process is success.
	118	+If "All tests successful" is shown, the setup process was successful.
119	119
120	120	## Configuration
121	121
...	...	@@ -125,48 +125,48 @@ Same as Shared Server's Configuration section.
125	125
126	126	### Start
127	127
128		-You can start application start.
129		-Application is run in background, port is 10020 by default.
	128	+You can start the application by running the provided gitprep script.
	129	+The application is run in the background and the port is 10020 by default.
130	130
131	131	./gitprep
132	132
133		-You can access the following URL.
	133	+Then access the following URL.
134	134
135	135	http://localhost:10020
136	136
137		-If you change port, edit gitprep.conf.
138		-If you can't access this port, you might change firewall setting.
	137	+If you want to change the port, edit gitprep.conf.
	138	+If you cannot access this port, you might change the firewall settings.
139	139
140	140	### Stop
141	141
142		-You can stop application by --stop option.
	142	+You can stop the application by adding the --stop option.
143	143
144	144	./gitprep --stop
145	145
146	146	### Operation from root user
147	147
148		-You can operation application from root user.
	148	+You can manage the application from the root user.
149	149
150		-Start application
	150	+Start the application
151	151
152	152	sudo -u gitprep /home/gitprep/gitprep/gitprep
153	153
154		-Stop application
	154	+Stop the application
155	155
156	156	sudo -u gitprep /home/gitprep/gitprep/gitprep --stop
157	157
158		-If you want to start application when OS start,
	158	+If you want to start the application when the OS starts,
159	159	add the start application command to rc.local(Linux).
160	160
161		-If you want to make easy to manage gitprep,
162		-Let's create run script.
	161	+If you want to make it easy to manage gitprep,
	162	+then create a run script.
163	163
164	164	mkdir -p /webapp
165	165	echo '#!/bin/sh' > /webapp/gitprep
166	166	echo 'sudo -u gitprep /home/gitprep/gitprep/gitprep $*' >> /webapp/gitprep
167	167	chmod 755 /webapp/gitprep
168	168
169		-You can start and stop application the following command.
	169	+You can start and stop the application with the following command.
170	170
171	171	# Start or Restart
172	172	/webapp/gitprep
...	...	@@ -176,11 +176,11 @@ You can start and stop application the following command.
176	176
177	177	## Developer
178	178
179		-If you are developer, you can start application development mode
	179	+If you are a developer, you can start the application in development mode.
180	180
181	181	./morbo
182	182
183		-You can access the following URL.
	183	+Then access the following URL.
184	184
185	185	http://localhost:3000
186	186