Permalink
Browse files

update docs.

  • Loading branch information...
reecefowell committed May 25, 2012
1 parent 9e2b241 commit f7c26e14a55c3e876743f44e4b1f1532ef2e3660
Showing with 211 additions and 24 deletions.
  1. +36 −24 README.md
  2. +10 −0 Resources/doc/index.md
  3. +57 −0 Resources/doc/install.md
  4. +108 −0 Resources/meta/LICENSE
View
@@ -1,12 +1,11 @@
-CCDNForum Forum Bundle(s) README.
-=================================
+lib-geshi for Symfony2 Bundle(s) README.
+========================================
This is a lib file for use in a project with Symfony2.
-Notes:
-------
+## Notes:
-This bundle is for the symfony framework and thusly requires Symfony 2.0.x and PHP 5.3.6
+This bundle is for the symfony framework and requires Symfony 2.0.x and PHP 5.3.6
This project uses Doctrine 2.0.x and so does not require any specific database.
@@ -20,31 +19,44 @@ Available on github <http://www.github.com/codeconsortium/>
For the full copyright and license information, please view the LICENSE
file that was distributed with this source code.
+## Description:
+
+GeSHi is a generic syntax highlighter.
+
+This lib file has been tailored to bootstrap the GeSHi lib in compliance with Symfony2's lib namespace and 3rd party library loading specifications.
+
+See the GeSHi homepage for more information.
+
See also: [Add third party libraries to symfony 2](http://www.kiwwito.com/article/add-third-party-libraries-to-symfony-2)
-Installation:
--------------
+## Features.
+
+For a full list of features, see the [GeSHi official website](http://qbnz.com/highlighter/).
+
+## Documentation.
+
+Documentation can be found in the `Resources/doc/index.md` file in this bundle:
+
+[Read the Documentation](http://github.com/codeconsortium/lib-geshi/blob/master/Resources/doc/index.md).
+
+## Installation.
+
+All the installation instructions are located in [documentation](http://github.com/codeconsortium/lib-geshi/blob/master/Resources/doc/Install.md).
+
+## License.
+
+This software is licensed under the GNU GENERAL PUBLIC LICENSE. See the complete license file in the bundle:
-1) Add to your deps.
+ Resources/meta/LICENSE
-```sh
-[libgeshi]
- git=http://github.com/codeconsortium/geshi.git
- target=/geshi
-```
+[Read the License](http://github.com/codeconsortium/lib-geshi/blob/master/Resources/meta/LICENSE).
-2) Add to your autoload.php
+## About.
-```sh
-# app/autoload.php
+See also the list of [contributors](http://github.com/codeconsortium/lib-geshi/contributors).
-$loader->registerPrefixes(array(
- 'Geshi_' => __DIR__.'/../vendor/geshi/lib',
-));
-```
+## Reporting an issue or feature request.
-3) To use GeSHi use:
+Issues and feature requests are tracked in the [Github issue tracker](http://github.com/codeconsortium/lib-geshi/issues).
-```php
- $geshi = new \Geshi_Geshi($tag, $lang);
-```
+Discussions and debates on the project can be further discussed at [Code Consortium](http://www.codeconsortium.com).
View
@@ -0,0 +1,10 @@
+lib-geshi Documentation.
+========================
+
+## Prerequisites
+
+This version of the bundle requires at least Symfony version 2.0.11.
+
+## Installation Documentation:
+
+- [Installing lib-geshi for Symfony 2.0.11](http://github.com/codeconsortium/lib-geshi/blob/master/Resources/doc/Install.md).
View
@@ -0,0 +1,57 @@
+Installing CCDNComponent AttachmentBundle 1.0
+=============================================
+
+## Dependencies:
+
+No dependencies.
+
+## Installation:
+
+Installation takes only 3 steps:
+
+1. Download and install the dependencies.
+2. Register bundles with autoload.php.
+3. Run vendors install script.
+
+### Step 1: Download and install the dependencies.
+
+Add to your deps.
+
+``` ini
+[lib-geshi]
+ git=http://github.com/codeconsortium/lib-geshi.git
+ target=/geshi
+```
+### Step 2: Register bundles with autoload.php.
+
+Add to your autoload.php
+
+``` php
+// app/autoload.php
+$loader->registerPrefixes(array(
+ 'Geshi_' => __DIR__.'/../vendor/geshi/lib',
+ **...**
+));
+```
+
+### Step 3: Run vendors install script.
+
+From your projects root Symfony directory on the command line run:
+
+``` bash
+$ php bin/vendors install
+```
+
+## Next Steps.
+
+Installation should now be complete!
+
+To use GeSHi use:
+
+``` php
+ $geshi = new \Geshi_Geshi($tag, $lang);
+```
+
+If you need further help/support, have suggestions or want to contribute please join the community at [Code Consortium](http://www.codeconsortium.com)
+
+[Return back to the docs index](http://github.com/codeconsortium/lib-geshi/blob/master/Resources/doc/index.md).
Oops, something went wrong.

0 comments on commit f7c26e1

Please sign in to comment.