winter/README.md

54 lines
2.6 KiB
Markdown
Raw Normal View History

2015-03-04 18:18:48 +11:00
<p align="center">
<img src="https://github.com/octobercms/october/blob/master/themes/demo/assets/images/october.png?raw=true" alt="October" />
</p>
2015-02-20 18:16:38 +11:00
2015-03-04 18:18:48 +11:00
[October](http://octobercms.com) is a Content Management System (CMS) and web platform whose sole purpose is to make your development workflow simple again. It was born out of frustration with existing systems, we feel building websites has become a convoluted and confusing process that leaves developers unsatisfied. We want to turn you around to the simpler side and get back to basics.
2013-11-26 15:30:43 -08:00
2013-11-27 12:21:42 +11:00
October's mission is to show the world that web development is not rocket science.
### Learning October
2015-03-29 11:00:35 +11:00
The best place to learn October is by [reading the documentation](http://octobercms.com/docs) or [the resources page](http://octobercms.com/resources).
2013-11-27 12:21:42 +11:00
2014-05-17 14:40:24 +10:00
### Installing October
2015-03-29 11:00:35 +11:00
Instructions on how to install October can be found at the [installation guide](http://octobercms.com/docs/help/install).
2014-05-17 14:40:24 +10:00
2013-11-27 12:21:42 +11:00
### Development Team
2013-12-02 19:48:42 -08:00
October was created by [Alexey Bobkov](http://ca.linkedin.com/pub/aleksey-bobkov/2b/ba0/232) and [Samuel Georges](http://au.linkedin.com/pub/sam-georges/31/641/a9), who both continue to develop the platform.
2013-11-27 12:23:11 +11:00
2014-05-15 11:05:49 +10:00
### Coding standards
Please follow the following guides and code standards:
2015-02-10 17:18:57 +11:00
* [PSR 4 Coding Standards](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-4-autoloader.md)
2014-05-15 11:05:49 +10:00
* [PSR 2 Coding Style Guide](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md)
* [PSR 1 Coding Standards](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-1-basic-coding-standard.md)
### Foundation library
The CMS uses [Laravel](http://laravel.com) as a foundation PHP framework.
2014-05-15 11:05:49 +10:00
2014-08-09 13:04:16 +10:00
### Using LESS
2014-08-09 13:04:00 +10:00
2015-03-02 19:08:04 +11:00
The theme is based on the Twitter Bootstrap framework and uses LESS language for generating the CSS. Please use a suitable LESS application for compiling the **assets/less/*.less** file to **assets/css/*.css**. The following application is recommended:
2014-08-09 13:04:00 +10:00
2015-03-02 19:08:04 +11:00
* [Koala](http://koala-app.com/)
2014-08-09 13:04:00 +10:00
2014-05-15 11:05:49 +10:00
### Contact
2013-11-27 12:23:11 +11:00
You can communicate with us using the following mediums:
2013-11-27 16:49:54 +11:00
* [Follow us on Twitter](http://twitter.com/octobercms) for announcements and updates.
2014-05-15 11:05:49 +10:00
* [Follow us on Facebook](http://facebook.com/octobercms) for announcements and updates.
2013-11-27 16:49:54 +11:00
* [Join us on IRC](https://kiwiirc.com/client/irc.freenode.net/?nick=Octonaut|?#october) to chat with us.
2014-05-16 09:07:27 +10:00
### License
2014-05-16 09:07:27 +10:00
The OctoberCMS platform is open-sourced software licensed under the [MIT license](http://opensource.org/licenses/MIT).
2014-06-20 20:17:36 +10:00
### Contributing
2015-03-29 10:59:22 +11:00
Before sending a Pull Request, be sure to review the [Contributing Guidelines](CONTRIBUTING.md) first.