Update README.md
- New Contributing section - Various small improvements
This commit is contained in:
Daniel Rudolf
parent
8db3bc5a18
commit
92adb27da5
40
README.md
40
README.md
|
|
@ -1,9 +1,10 @@
|
|||
Pico
|
||||
====
|
||||
|
||||
[](https://scrutinizer-ci.com/g/theshka/Pico/build-status/LICENSE)
|
||||
[]()
|
||||
[](https://scrutinizer-ci.com/g/theshka/Pico/build-status/master) [](https://scrutinizer-ci.com/g/theshka/Pico/?branch=master)
|
||||
[](https://scrutinizer-ci.com/g/theshka/Pico/build-status/LICENSE)
|
||||
[](https://github.com/picocms/Pico/releases/latest)
|
||||
[](https://scrutinizer-ci.com/g/theshka/Pico/build-status/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.
|
||||
|
||||
|
|
@ -41,16 +42,15 @@ $ 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.
|
||||
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...
|
||||
Pico follows [Semantic Versioning 2.0][SemVer] 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).
|
||||
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][UpgradeNotes].
|
||||
|
||||
Run
|
||||
---
|
||||
|
|
@ -58,7 +58,6 @@ Run
|
|||
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.
|
||||
|
||||
#### You don't have a web server?
|
||||
|
||||
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!
|
||||
|
||||
###### Step 1
|
||||
|
|
@ -85,18 +84,25 @@ Issues with plugins should be reported on the offending plugins homepage, same g
|
|||
Contributing
|
||||
------------
|
||||
|
||||
Help make PicoCMS better by checking out the GitHub repository and submitting pull requests.
|
||||
You want to contribute to Pico? We really appreciate that! You can help making Pico better by [contributing code][PullRequests] or [reporting issues][Issues], but please take note of our [contribution guidelines][ContributionGuidelines]. In general you can contribute in four different areas:
|
||||
|
||||
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...
|
||||
1. Issues: You have a problem with Pico? Please don't hesitate to create a new [Issue][Issues] on GitHub! Concerning problems with plugins or themes, please refer to the website of the developer of this plugin or theme.
|
||||
2. Plugins & Themes: You're a plugin developer or theme designer? We love you guys! You can find tons of information about how to develop plugins and themes at http://picocms.org/plugin-dev.html. If you have created a plugin or theme, please add it to our [Wiki][], either on the [plugins][WikiPlugins] or [themes page][WikiThemes]. Maybe we will then promote your plugin or theme on [our website][OfficialPlugins] as officially supported!
|
||||
3. Documentation: We always appreciate people improving our documentation. You can either improve the [inline user docs][InlineUserDocs] or the more extensive [user docs on our website][WebsiteUserDocs]. You can also improve the [docs for plugin and theme developers][WebsiteDevDocs]. Simply fork Pico from https://github.com/picocms/Pico, change the Markdown files and open a [pull request][PullRequests].
|
||||
4. Picos Core: The supreme discipline is to work on Picos Core. Your contribution should help *every* Pico user to have a better experience with Pico. If this is the case, fork Pico from https://github.com/picocms/Pico and open a [pull request][PullRequests]. We look forward to your contribution!
|
||||
|
||||
[LatestRelease]: https://github.com/picocms/Pico/releases/latest
|
||||
[composer]: https://getcomposer.org/
|
||||
[SemVer]: http://semver.org
|
||||
[UpgradeNotes]: http://picocms.org/upgrade.html
|
||||
[PHPServer]: http://php.net/manual/en/features.commandline.webserver.php
|
||||
[PullRequests]: https://github.com/picocms/Pico/pulls
|
||||
[Issues]: https://github.com/picocms/Pico/issues
|
||||
[ContributionGuidelines]: https://github.com/picocms/Pico/blob/master/CONTRIBUTING.md
|
||||
[Wiki]: https://github.com/picocms/Pico/wiki
|
||||
[WikiPlugins]: https://github.com/picocms/Pico/wiki/Pico-Plugins
|
||||
[WikiThemes]: https://github.com/picocms/Pico/wiki/Pico-Themes
|
||||
[OfficialPlugins]: http://picocms.org/plugins.html
|
||||
[InlineUserDocs]: https://github.com/picocms/Pico/blob/master/content-sample/index.md
|
||||
[WebsiteUserDocs]: https://github.com/picocms/Pico/tree/gh-pages/_docs
|
||||
[WebsiteDevDocs]: https://github.com/picocms/Pico/tree/gh-pages/_plugin-dev
|
||||
|
|
|
|||
Loading…
Reference in a new issue