beenull/Pico
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

Update README

Browse source
This commit is contained in:
theshka 2015-10-02 17:02:27 -06:00
parent 2fdcacc14b
commit a8e68eaac8
1 changed files with 37 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

44
README.md
View file

@ -1,14 +1,28 @@
Pico
====
# 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.
<!--flippa verify-->
[![I Love Open Source](http://www.iloveopensource.io/images/logo-lightbg.png)](http://www.iloveopensource.io/projects/524c55dcca7964c617000756)
Install
-------
Requirements
---
Requires PHP 5.3+
Download
---
You can install the latest version either by downloading it from <http://picocms.org/> or use Git:
```shell
git clone https://github.com/picocms/Pico.git
```
Install
---
Download [composer](<https://getcomposer.org/>) and run it with install option.
$ curl -sS https://getcomposer.org/installer | php
@ -19,10 +33,26 @@ Run
The easiest way to Pico is using [the built-in web server on PHP](<http://php.net/manual/en/features.commandline.webserver.php>).
$ php -S 0.0.0.0:8080 ./
$ php -S 0.0.0.0:8080
Pico will be accessible from <http://localhost:8080>.
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](https://github.com/picocms/Pico/wiki) for docs, plugins, themes, etc...