improve readme ・ 4f9c335 ・ Gitprep

+40 -40

README.md

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