ORIENT/README.md

62 lines
3.1 KiB
Markdown
Raw Normal View History

2015-02-20 07:16:38 +00:00
.====================================================================.
.d8888b. .o8888b. db .d8888b. d8888b. d88888b d8888b. .d888b.
.8P Y8. d8P Y8 88 .8P Y8. 88 `8D 88' 88 `8D .8P , Y8.
88 88 8P oooo88 88 88 88oooY' 88oooo 88oobY' 88 | 88
88 88 8b ~~~~88 88 88 88~~~b. 88~~~~ 88`8b 88 |/ 88
`8b d8' Y8b d8 88 `8b d8' 88 8D 88. 88 `88. `8b | d8'
`Y8888P' `Y8888P' YP `Y8888P' Y8888P' Y88888P 88 YD `Y888P'
`========================= GET BACK TO BASICS ======================='
[October](http://octobercms.com) is a Content Management System (CMS) and web platform whose sole purpose is to make your development workflow simple again. 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 23:30:43 +00:00
2013-11-27 01:21:42 +00:00
October's mission is to show the world that web development is not rocket science.
### Learning October
The best place to learn October is by [reading the documentation](http://octobercms.com/docs).
2014-05-17 04:40:24 +00:00
### Installing October
Instructions on how to install October can be found at the [installation guide](http://octobercms.com/docs/help/install).
2013-11-27 01:21:42 +00:00
### Development Team
2013-12-03 03:48:42 +00: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 01:23:11 +00:00
2014-05-15 01:05:49 +00:00
### Coding standards
Please follow the following guides and code standards:
2015-02-10 06:18:57 +00:00
* [PSR 4 Coding Standards](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-4-autoloader.md)
2014-05-15 01:05:49 +00: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 01:05:49 +00:00
2014-08-09 03:04:16 +00:00
### Using LESS
2014-08-09 03:04:00 +00: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 applications are recommended:
* [LESS.app](http://incident57.com/less/) for Mac
* [WinLess](http://winless.org/) for Windows
2014-10-09 22:04:12 +00:00
* [Koala](http://koala-app.com/) for Linux
2014-08-09 03:04:00 +00:00
2014-05-15 01:05:49 +00:00
### Contact
2013-11-27 01:23:11 +00:00
You can communicate with us using the following mediums:
2013-11-27 05:49:54 +00:00
* [Follow us on Twitter](http://twitter.com/octobercms) for announcements and updates.
2014-05-15 01:05:49 +00:00
* [Follow us on Facebook](http://facebook.com/octobercms) for announcements and updates.
2013-11-27 05:49:54 +00:00
* [Join us on IRC](https://kiwiirc.com/client/irc.freenode.net/?nick=Octonaut|?#october) to chat with us.
2014-05-15 23:07:27 +00:00
### License
2014-05-15 23:07:27 +00:00
The OctoberCMS platform is open-sourced software licensed under the [MIT license](http://opensource.org/licenses/MIT).
2014-06-20 10:17:36 +00:00
### Contributing
Before sending a Pull Request, be sure to review the [Contributing Guidelines](CONTRIBUTING.md) first.