Skip to content

Commit 88bfaec

Browse files
committed
Merge pull request #3 from skylying/patch-2
update getting-started.md
2 parents 9171fe5 + fdcd9c0 commit 88bfaec

File tree

1 file changed

+19
-19
lines changed

1 file changed

+19
-19
lines changed

.vaseman/entries/documentation/start/getting-started.md

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -10,20 +10,20 @@ title: Getting Started
1010
Windwalker use [Composer](https://getcomposer.org/) as package manager, make sure you [install composer](https://getcomposer.org/download/)
1111
first.
1212

13-
To start install Windwalker, please open terminal and type this command:
13+
To start install Windwalker, please open terminal and type the following:
1414

1515
``` bash
1616
$ php composer.phar create-project windwalker/starter project_dir 2.0.* --no-dev
1717
```
1818

19-
> If you want to use unit test or develop Windwalker it-self, remove `--no-dev` option.
19+
> For use of unit test or any development purpose, simply remove `--no-dev` option.
2020
2121
The [Starter](https://github.com/ventoviro/windwalker-starter) package is a default application to start a project (like Symfony Standard).
2222
If you want to use Windwalker as a library, see next section.
2323

2424
## Use Windwalker as Library
2525

26-
If you have your own application project and want to include Windwalker as library, just add `windwalker/framework` to require block in `composer.json`.
26+
Add `windwalker/framework` as your project's dependencies in `composer.json`.
2727

2828
``` json
2929
{
@@ -33,9 +33,9 @@ If you have your own application project and want to include Windwalker as libra
3333
}
3434
```
3535

36-
> `~2.0` means 2.0 to 2.9
36+
> `~2.0` is equivalent to 2.0 to 2.9
3737
38-
You can also install specific packages instead install whole framework. This is an example to install Session and Form package:
38+
You can also pick any child packages rather than the complete framework set. This is an example to install Session and Form package:
3939

4040
``` json
4141
{
@@ -56,28 +56,28 @@ After installed, use browser open `/www` then you will see default landing page.
5656

5757
![img](https://cloud.githubusercontent.com/assets/1639206/5576484/31c9834c-9037-11e4-9f97-8f73d0822043.png)
5858

59-
## The File Structure
59+
## File Structure
6060

6161
| Name | Description |
6262
| ---- | ----------- |
63-
| `/bin` | All executable files, there is a `console` file can run Windwalker Console |
63+
| `/bin` | All executable files, there is a `console` file can run Windwalker Console. |
6464
| `/etc` | All configuration and routing files. |
6565
| ` -- define.php` | The system path constants. |
6666
| ` -- config.yml` | Basic configuration file. |
67-
| ` -- secret.dist.yml` | Contains some secret information like DB account. <br /> Please rename to `secret.yml` to use it |
68-
| ` -- routing.yml` | The routing configuration file |
69-
| `/resources` | Some non-PHP or non-classes files |
70-
| ` -- languages` | Language files, default is INI format |
67+
| ` -- secret.dist.yml` | Contains some secret information like DB account. <br /> Please rename to `secret.yml` before use. |
68+
| ` -- routing.yml` | The routing configuration file. |
69+
| `/resources` | Some non-PHP or non-classes files. |
70+
| ` -- languages` | Language files, default is `.ini` format |
7171
| ` -- migrations` | Database migration files. See [Migration](../db/migration.html) |
7272
| ` -- seeders` | Database seeder files. See [Seeder](../db/seeder.html) |
73-
| `/src` | All PHP classes files for your project. |
74-
| `/templates` | The layout files. |
75-
| `/vendor` | All 3rd libraries files |
76-
| `/www` | Web public root |
77-
| ` -- media` | Assets files for front-end |
73+
| `/src` | All PHP classes in your project. |
74+
| `/templates` | Layout and template files. |
75+
| `/vendor` | All 3rd party libraries. |
76+
| `/www` | Web public root (or /public in general) |
77+
| ` -- media` | Web front-end assets (image, vedio, css, etc..) |
7878
| ` -- .htaccess` | Htaccess config for Apache, you need this file to make mod_rewrite work. |
79-
| ` -- index.php` | System entry. |
80-
| ` -- dev.php` | System entry for Development mode. |
81-
| `/phpunit.xml.dist` | PHPUnit configuration file. Rebane to `phpunit.xml` to use. |
79+
| ` -- index.php` | Default web application entrance. |
80+
| ` -- dev.php` | Default web application entrance for dev environment. |
81+
| `/phpunit.xml.dist` | PHPUnit configuration file. Rename to `phpunit.xml` before use. |
8282
| `/README.md` | Readme file |
8383
| `/composer.json` | Composer configuration file |

0 commit comments

Comments
 (0)