Permalink
Browse files

Minor formatting clean up

  • Loading branch information...
1 parent 55c397f commit 40993debebbbbfee681746ca9749ff70497744f2 @mehlah mehlah committed Jun 13, 2011
Showing with 13 additions and 24 deletions.
  1. +7 −13 console/README.md
  2. +6 −11 template/README.md
View
@@ -1,6 +1,5 @@
-
-The console package contains a set of classes required to route and dispatch
-incoming console requests. Moreover it contains the console front-controller
+**The console package contains a set of classes required to route and dispatch
+incoming console requests.** Moreover it contains the console front-controller
file (`lithium.php`) as well as wrappers for both *nix and Windows environments
(`li3` and `li3.bat` respectively), allowing to easily invoke the
console front-controller from the command line.
@@ -17,7 +16,6 @@ complete access to your application. This is especially useful to reuse
existing logic in an application's model when creating a command to be run as
i.e. a cron-job.
------
## Invoking the front-controller ##
@@ -53,14 +51,12 @@ by sourcing the modified profile through the following command.
If you can't or don't want to modify your `$PATH` you use two other techniques
to make the wrapper available as just `li3`. You can either symlink the
-wrapper into one of the paths found in the `$PATH` environment variable or
-create a permanent alias by adding an alias to i.e. the `.bashrc` file in your
-home directory.
+wrapper into one of the paths found in the `$PATH` environment variable
$ cd /path/to/a/directory/in/your/path
- $ ln -s /path/to/libraries/lithium/console .
-
+ $ ln -s /path/to/libraries/lithium/console
+or create a permanent alias by adding an alias to i.e. the `.bashrc` file in your home directory.
alias li3='/path/to/lithium/libraries/lithium/console/li3'
@@ -75,7 +71,7 @@ home directory.
* Open the _Advanced_ tab.
* Clicking the _Environment Variables_ button open a dialog where you can edit the variables.
* Double click the _PATH_ entry in order to edit it.
- * Add `;C:\path\to\php;C:\path\to\libraries\lithium\console` to the end of the value.
+ * Add `C:\path\to\php;C:\path\to\libraries\lithium\console` to the end of the value.
### Finishing up ###
@@ -87,7 +83,6 @@ list of available commands.
$ li3
$ li3.bat
------
## Built-in commands ##
@@ -100,7 +95,6 @@ the `help` command.
$ li3 help create
$ li3 help g11n
------
## Creating custom commands ##
@@ -184,4 +178,4 @@ Try it out with the following command:
$ li3 hello_world --recipient=AwesomeGuy
-You should get a special greeting from our good old `hello_world` command.
+You should get a special greeting from our good old `hello_world` command.
View
@@ -1,4 +1,3 @@
-
## Special syntax ##
Views have a special syntax for outputting escaped text. The standard way to
@@ -43,7 +42,6 @@ An example would be something like:
* [Introduction to PHP streams](http://www.php.net/intro.stream)
* [Stream examples](http://www.php.net/stream.examples)
-----
## Using helpers ##
@@ -62,11 +60,10 @@ performance impact.
**More info**
- * [ HTML helper](template/helper/Html)
- * [ Form helper](template/helper/Form)
- * [ Helper base class](template/Helper)
+ * [HTML helper](template/helper/Html)
+ * [Form helper](template/helper/Form)
+ * [Helper base class](template/Helper)
-----
## Creating custom helpers ##
@@ -98,7 +95,6 @@ You can then use your helper in templates as follows:
Your custom helper will then be auto-loaded into the templating engine from your application or a
plugin.
-----
## Extending core helpers ##
@@ -125,7 +121,6 @@ Your custom `Form` helper will now be invoked in all instances where `$this->for
template. For more information on the load order of classes, see
the `locate()` method of the `Libraries` class (`core/Libraries::locate`)
-----
## Rendering elements ##
@@ -155,6 +150,6 @@ If you need the element template to not have access to existing data passed to t
**More info**
- * `View` (`template/View`)
- * `Renderer` (`template/view/Renderer`)
- * `File adapter` (`template/view/adapter/File`)
+ * [View](template/View)
+ * [Renderer](template/view/Renderer)
+ * [File adapter](template/view/adapter/File)

0 comments on commit 40993de

Please sign in to comment.