Skip to content

Commit 4c77912

Browse files
committed
typo
1 parent 88bfaec commit 4c77912

File tree

2 files changed

+27
-27
lines changed

2 files changed

+27
-27
lines changed

documentation/start/getting-started.html

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -216,23 +216,23 @@ <h1>Installation</h1>
216216
<h2>Install Starter Application</h2>
217217

218218
<p>Windwalker use <a href="https://getcomposer.org/">Composer</a> as package manager, make sure you <a href="https://getcomposer.org/download/">install composer</a>
219-
before installing it.</p>
219+
first.</p>
220220

221-
<p>To start install Windwalker, please open terminal and type this command:</p>
221+
<p>To start install Windwalker, please open terminal and type the following:</p>
222222

223223
<pre><code class="bash">$ php composer.phar create-project windwalker/starter project_dir 2.0.* --no-dev
224224
</code></pre>
225225

226226
<blockquote>
227-
<p>If you want to use unit test or develop Windwalker it-self, remove <code>--no-dev</code> option.</p>
227+
<p>For use of unit test or any development purpose, simply remove <code>--no-dev</code> option.</p>
228228
</blockquote>
229229

230230
<p>The <a href="https://github.com/ventoviro/windwalker-starter">Starter</a> package is a default application to start a project (like Symfony Standard).
231231
If you want to use Windwalker as a library, see next section.</p>
232232

233233
<h2>Use Windwalker as Library</h2>
234234

235-
<p>If you have your own application project and want to include Windwalker as library, just add <code>windwalker/framework</code> to require block in <code>composer.json</code>.</p>
235+
<p>Add <code>windwalker/framework</code> as your project's dependencies in <code>composer.json</code>.</p>
236236

237237
<pre><code class="json">{
238238
"require": {
@@ -242,10 +242,10 @@ <h2>Use Windwalker as Library</h2>
242242
</code></pre>
243243

244244
<blockquote>
245-
<p><code>~2.0</code> means 2.0 to 2.9</p>
245+
<p><code>~2.0</code> is equivalent to 2.0 to 2.9</p>
246246
</blockquote>
247247

248-
<p>You can also install specific packages instead install whole framework. This is an example to install Session and Form package:</p>
248+
<p>You can also pick any child packages rather than the complete framework set. This is an example to install Session and Form package:</p>
249249

250250
<pre><code class="json">{
251251
"require": {
@@ -265,7 +265,7 @@ <h2>Open Windwalker Public Root</h2>
265265

266266
<p><img src="https://cloud.githubusercontent.com/assets/1639206/5576484/31c9834c-9037-11e4-9f97-8f73d0822043.png" alt="img" /></p>
267267

268-
<h2>The File Structure</h2>
268+
<h2>File Structure</h2>
269269

270270
<table>
271271
<thead>
@@ -277,7 +277,7 @@ <h2>The File Structure</h2>
277277
<tbody>
278278
<tr>
279279
<td><code>/bin</code></td>
280-
<td>All executable files, there is a <code>console</code> file can run Windwalker Console</td>
280+
<td>All executable files, there is a <code>console</code> file can run Windwalker Console.</td>
281281
</tr>
282282
<tr>
283283
<td><code>/etc</code></td>
@@ -293,19 +293,19 @@ <h2>The File Structure</h2>
293293
</tr>
294294
<tr>
295295
<td><code>-- secret.dist.yml</code></td>
296-
<td>Contains some secret information like DB account. <br /> Please rename to <code>secret.yml</code> to use it</td>
296+
<td>Contains some secret information like DB account. <br /> Please rename to <code>secret.yml</code> before use.</td>
297297
</tr>
298298
<tr>
299299
<td><code>-- routing.yml</code></td>
300-
<td>The routing configuration file</td>
300+
<td>The routing configuration file.</td>
301301
</tr>
302302
<tr>
303303
<td><code>/resources</code></td>
304-
<td>Some non-PHP or non-classes files</td>
304+
<td>Some non-PHP or non-classes files.</td>
305305
</tr>
306306
<tr>
307307
<td><code>-- languages</code></td>
308-
<td>Language files, default is INI format</td>
308+
<td>Language files, default is <code>.ini</code> format</td>
309309
</tr>
310310
<tr>
311311
<td><code>-- migrations</code></td>
@@ -317,39 +317,39 @@ <h2>The File Structure</h2>
317317
</tr>
318318
<tr>
319319
<td><code>/src</code></td>
320-
<td>All PHP classes files for your project.</td>
320+
<td>All PHP classes in your project.</td>
321321
</tr>
322322
<tr>
323323
<td><code>/templates</code></td>
324-
<td>The layout files.</td>
324+
<td>Layout and template files.</td>
325325
</tr>
326326
<tr>
327327
<td><code>/vendor</code></td>
328-
<td>All 3rd libraries files</td>
328+
<td>All 3rd party libraries.</td>
329329
</tr>
330330
<tr>
331331
<td><code>/www</code></td>
332-
<td>Web public root</td>
332+
<td>Web public root (or /public in general)</td>
333333
</tr>
334334
<tr>
335335
<td><code>-- media</code></td>
336-
<td>Assets files for front-end</td>
336+
<td>Web front-end assets (image, vedio, css, etc..)</td>
337337
</tr>
338338
<tr>
339339
<td><code>-- .htaccess</code></td>
340340
<td>Htaccess config for Apache, you need this file to make mod_rewrite work.</td>
341341
</tr>
342342
<tr>
343343
<td><code>-- index.php</code></td>
344-
<td>System entry.</td>
344+
<td>Default web application entrance.</td>
345345
</tr>
346346
<tr>
347347
<td><code>-- dev.php</code></td>
348-
<td>System entry for Development mode.</td>
348+
<td>Default web application entrance for dev environment.</td>
349349
</tr>
350350
<tr>
351351
<td><code>/phpunit.xml.dist</code></td>
352-
<td>PHPUnit configuration file. Rebane to <code>phpunit.xml</code> to use.</td>
352+
<td>PHPUnit configuration file. Rename to <code>phpunit.xml</code> before use.</td>
353353
</tr>
354354
<tr>
355355
<td><code>/README.md</code></td>

documentation/start/routing-controller.html

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -217,7 +217,7 @@ <h1>Create Simple Routing</h1>
217217

218218
<pre><code class="http">flower:
219219
pattern: /flower/sakura
220-
controller: Flower\Controllr\Sakura
220+
controller: Flower\Controller\Sakura
221221
</code></pre>
222222

223223
<p>If you use browser open <code>/flower/sakura</code>, Windwalker will call <code>Flower\Controller\Sakura\GetController</code> and execute it.</p>
@@ -279,7 +279,7 @@ <h2>Use Controller</h2>
279279

280280
<pre><code class="http">flower:
281281
pattern: /flower/(id)
282-
controller: Flower\Controlelr\Sakura
282+
controller: Flower\Controller\Sakura
283283
</code></pre>
284284

285285
<p>Lets create a controller at <code>src/Flower/Controller/Sakura/GetController.php</code>:</p>
@@ -322,17 +322,17 @@ <h2>Override Actions</h2>
322322

323323
<pre><code class="http">flower:
324324
pattern: /flower/sakura
325-
controller: Flower\Controlelr\Sakura
325+
controller: Flower\Controller\Sakura
326326
action:
327327
get: IndexController
328328
</code></pre>
329329

330-
<p>The GET method will match <code>Flower\Controlelr\Sakura\IndexController</code> because we set a map to find new name. We can set more
330+
<p>The GET method will match <code>Flower\Controller\Sakura\IndexController</code> because we set a map to find new name. We can set more
331331
methods to mapping methods with controllers.</p>
332332

333333
<pre><code class="http">flower:
334334
pattern: /flower/sakura
335-
controller: Flower\Controlelr\Sakura
335+
controller: Flower\Controller\Sakura
336336
action:
337337
get: IndexController
338338
post: CreateController
@@ -358,7 +358,7 @@ <h2>Limit By Methods</h2>
358358

359359
<pre><code class="http">flower:
360360
pattern: /flower/sakura
361-
controller: Flower\Controlelr\Sakura
361+
controller: Flower\Controller\Sakura
362362
method:
363363
- GET
364364
- POST
@@ -368,7 +368,7 @@ <h2>Limit By Other Options</h2>
368368

369369
<pre><code class="apache">flower:
370370
pattern: /flower/sakura
371-
controller: Flower\Controlelr\Sakura
371+
controller: Flower\Controller\Sakura
372372
method:
373373
- GET
374374
- POST

0 commit comments

Comments
 (0)