Pico/README.md

103 lines
5.2 KiB
Markdown
Raw Normal View History

2013-05-08 13:34:29 +00:00
Pico
====
2015-10-02 23:02:27 +00:00
[![License](https://img.shields.io/packagist/l/doctrine/orm.svg)](https://scrutinizer-ci.com/g/theshka/Pico/build-status/LICENSE)
2015-10-04 14:59:38 +00:00
[![Version](https://img.shields.io/badge/version-1.0-lightgrey.svg)]()
2015-10-02 23:02:27 +00:00
[![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)
2013-05-08 13:34:29 +00:00
2014-03-25 11:23:00 +00:00
Pico is a stupidly simple, blazing fast, flat file CMS. See http://picocms.org/ for more info.
2015-10-03 15:36:43 +00:00
2014-11-07 11:04:43 +00:00
<!--flippa verify-->
2013-10-02 17:23:08 +00:00
[![I Love Open Source](http://www.iloveopensource.io/images/logo-lightbg.png)](http://www.iloveopensource.io/projects/524c55dcca7964c617000756)
Install
-------
2015-04-29 00:02:10 +00:00
2015-10-03 15:36:43 +00:00
You can install Pico either using a pre-bundled release or with composer. Pico requires PHP 5.3+
#### Using a pre-bundled release
Just [download the latest Pico release][LatestRelease] and upload all files to the `httpdocs` directory (e.g. `/var/www/html`) of your server.
#### Composer
2015-10-03 16:35:17 +00:00
###### 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.
2015-10-03 15:36:43 +00:00
2015-10-03 16:35:17 +00:00
###### 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:
2015-10-02 23:02:27 +00:00
```shell
$ git clone https://github.com/picocms/Pico.git .
2015-10-02 23:02:27 +00:00
```
Please note that this gives you the current development version of Pico, what is likely *unstable* and *not ready for production use*!
2015-10-03 16:35:17 +00:00
###### Step 2
2015-10-03 15:36:43 +00:00
Download [composer][] and run it with the `install` option:
```shell
2015-10-03 15:36:43 +00:00
$ curl -sS https://getcomposer.org/installer | php
$ php composer.phar install
```
Upgrade
-------
Upgrading Pico is very easy: You just have to replace all of Picos files - that's it! Nevertheless you should *always* create a backup of your Pico installation
before upgrading.
Pico follows [Semantic Versioning 2.0](http://semver.org) and uses version numbers like `MAJOR`.`MINOR`.`PATCH`. When we update...
- the `PATCH` version (e.g. `1.0.0` to `1.0.1`), we made backwards-compatible bug fixes. It's then sufficient to extract [Picos latest release][LatestRelease] to your existing installation directory and overwriting all files.
- the `MINOR` version (e.g. `1.0` to `1.1`), we added functionality in a backwards-compatible manner, but anyway recommend you to "install" Pico newly. Backup all of your files, empty your installation directory and install Pico as elucidated above. You can then copy your `config/config.php` and `content` directory without any change. If applicable, you can also copy the folder of your custom theme within the `themes` directory. Provided that you're using plugins, also copy all of your plugins from the `plugins` directory.
- the `MAJOR` version (e.g. `1.0` to `2.0`), a appropriate upgrade tutorial will be provided.
Upgrading Pico 0.8 or 0.9 to Pico 1.0 is a special case. The new `PicoDeprecated` plugin ensures backwards compatibility, so you basically can follow the above upgrade instructions as if we updated the `MINOR` version. However, we recommend you to take some further steps to confine the neccessity of `PicoDeprecated` as far as possible. For more information about what has changed with Pico 1.0 and a step-by-step upgrade tutorial, please refer to the [upgrade page of our website](http://picocms.org/upgrade.html).
Run
---
2015-10-03 15:36:43 +00:00
You have nothing to consider specially, simply navigate to your Pico install using your favourite web browser. Picos default contents will explain how to use your brand new, stupidly simple, blazing fast, flat file CMS.
2015-10-03 16:35:17 +00:00
#### You don't have a web server?
2015-10-04 14:59:38 +00:00
Starting with PHP 5.4 the easiest way to try Pico is using [the built-in web server of PHP][PHPServer]. Please note that PHPs built-in web server is for development and testing purposes only!
2015-10-03 15:36:43 +00:00
2015-10-03 16:35:17 +00:00
###### Step 1
2015-10-03 15:36:43 +00:00
Navigate to Picos installation directory using a shell.
2015-10-03 16:35:17 +00:00
###### Step 2
2015-10-03 15:36:43 +00:00
Start PHPs built-in web server:
```shell
$ php -S 127.0.0.1:8080
2015-10-03 15:36:43 +00:00
```
2015-10-03 16:35:17 +00:00
###### Step 3
2015-10-03 15:36:43 +00:00
Access Pico from <http://localhost:8080>.
2015-04-29 03:39:25 +00:00
2015-10-02 23:02:27 +00:00
Getting Help
------------
You can read the [Wiki][] if you are looking for examples and read the inline-docs for more development information.
2015-10-02 23:02:27 +00:00
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
------------
2015-10-02 23:02:27 +00:00
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][].
2015-10-02 23:02:27 +00:00
Plugins + Wiki
--------------
2015-10-02 23:02:27 +00:00
Pico can be extended with a wide variety of plugins in order to add extra functionality, speed, or features.
2015-10-03 15:36:43 +00:00
Visit the [Pico Wiki][Wiki] for docs, plugins, themes, etc...
2015-10-03 15:36:43 +00:00
[LatestRelease]: https://github.com/picocms/Pico/releases/latest
[composer]: https://getcomposer.org/
[PHPServer]: http://php.net/manual/en/features.commandline.webserver.php
[Wiki]: https://github.com/picocms/Pico/wiki