diff --git a/README.md b/README.md index 778a958..f33e2ae 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,14 @@ Pico ==== +[![License](https://img.shields.io/packagist/l/doctrine/orm.svg)](https://scrutinizer-ci.com/g/theshka/Pico/build-status/LICENSE) +[![Version](https://img.shields.io/badge/version-0.9-lightgrey.svg)]() +[![Build Status](https://scrutinizer-ci.com/g/theshka/Pico/badges/build.png?b=master)](https://scrutinizer-ci.com/g/theshka/Pico/build-status/master) [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/theshka/Pico/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/theshka/Pico/?branch=master) + Pico is a stupidly simple, blazing fast, flat file CMS. See http://picocms.org/ for more info. -[![I Love Open Source](http://www.iloveopensource.io/images/logo-lightbg.png)][iloveopensource] +[![I Love Open Source](http://www.iloveopensource.io/images/logo-lightbg.png)](http://www.iloveopensource.io/projects/524c55dcca7964c617000756) Install ------- @@ -17,15 +21,19 @@ Just [download the latest Pico release][LatestRelease] and upload all files to t #### Composer -**Step 1** -[Download the *source code* of Picos latest release][LatestRelease] and upload all files to the `httpdocs` directory (e.g. `/var/www/html`) of your server. +**Step 1 - for users** +[Download the *source code* of Picos latest release][LatestRelease], upload all files to the `httpdocs` directory (e.g. `/var/www/html`) of your server and navigate to the upload directory using a shell. + +**Step 1 - for developers** +Open a shell and navigate to the desired install directory of Pico within the `httpdocs` directory (e.g. `/var/www/html`) of your server. You can now clone Picos Git repository as follows: +```shell +$ git clone https://github.com/picocms/Pico.git . +``` +Please note that this gives you the current development version of Pico, what is likely unstable and not ready for production use! **Step 2** -Navigate to the upload directory using a shell. - -**Step 3** Download [composer][] and run it with the `install` option: -```bash +```shell $ curl -sS https://getcomposer.org/installer | php $ php composer.phar install ``` @@ -44,19 +52,37 @@ Navigate to Picos installation directory using a shell. **Step 2** Start PHPs built-in web server: -```bash +```shell $ php -S 0.0.0.0:8080 ``` **Step 3** Access Pico from . -Wiki ----- +Getting Help +------------ -Visit the [Pico Wiki](https://github.com/picocms/Pico/wiki) for plugins, themes, etc. +You can read the wiki if you are looking for examples and read the inline-docs for more development information. + +If you find a bug please report it on the issues page, but remember to include as much detail as possible, and what someone can do to re-create the issue. + +Issues with plugins should be reported on the offending plugins homepage, same goes for themes. + +Contributing +------------ + +Help make PicoCMS better by checking out the GitHub repository and submitting pull requests. + +If you create a plugin please add it to the Wiki. + +Plugins + Wiki +-------------- + +Pico can be extended with a wide variety of plugins in order to add extra functionality, speed, or features. + +Visit the [Pico Wiki][Wiki] for docs, plugins, themes, etc... -[iloveopensource]: http://www.iloveopensource.io/projects/524c55dcca7964c617000756 [LatestRelease]: https://github.com/picocms/Pico/releases/latest [composer]: https://getcomposer.org/ -[PHPServer]: +[PHPServer]: http://php.net/manual/en/features.commandline.webserver.php +[Wiki]: https://github.com/picocms/Pico/wiki