Files
Grav/README.md

56 lines
2.4 KiB
Markdown
Raw Normal View History

2014-08-11 10:49:54 -07:00
![](https://avatars1.githubusercontent.com/u/8237355?v=2&s=50) Grav
2014-08-02 11:29:10 -07:00
====
2014-08-11 10:49:54 -07:00
Grav is a **Fast**, **Simple**, and **Flexible**, file-based Web-platform. There is **Zero** installation required. Just extract the ZIP archive, and you are already up and running. It follows similar principals to other flat-file CMS platforms, but has a different design philosophy than most.
2014-08-11 13:01:11 -05:00
The underlying architecture of Grav has been designed to use well-established and _best-in-class_ technologies, where applicable, to ensure that Grav is simple to use and easy to extend. Some of these key technologies include:
2014-08-11 10:49:54 -07:00
* [Twig Templating](http://twig.sensiolabs.org/): for powerful control of the user interface
* [Markdown](http://en.wikipedia.org/wiki/Markdown): for easy content creation
* [YAML](http://yaml.org): for simple configuration
* [Doctrine Cache](http://docs.doctrine-project.org/en/2.0.x/reference/caching.html): layer for incredible performance
2014-08-12 16:52:47 -06:00
QuickStart
==========
You have two options to get Grav:
### Downloading a Grav Package
You can download a **ready-built** package from the [Downloads page on http://getgrav.org](http://getgrav.org/downloads)
### From GitHub
1. Clone the Grav repository from [https://github.com/getgrav/grav]() to a folder in the webroot of your server, e.g. `~/webroot/grav`. Launch a **terminal** or **console** and navigate to the webroot folder:
```
$ cd ~/webroot
$ git clone https://github.com/getgrav/grav.git
```
2. Install the **plugin** and **theme dependencies** by using the [Grav CLI application](http://learn.getgrav.org/advanced/grav-cli) `bin/grav`:
```
$ cd ~/webroot/grav
$ bin/grav install
```
Check out the [install procedures](http://learn.getgrav.org/basics/installation) for more information.
2014-08-11 10:49:54 -07:00
Getting Started
===============
* [What is Grav?](http://learn.getgrav.org/basics/what-is-grav)
* [Install](http://learn.getgrav.org/basics/installation) Grav in few seconds
* Understand the [Configuration](http://learn.getgrav.org/basics/grav-configuration)
2014-08-11 13:01:11 -05:00
* Take a peek at our available free [Skeletons](http://getgrav.org/downloads/skeletons#extras)
* If you have questions, check out `#grav` on irc.freenode.net
* Have fun!
2014-08-11 10:49:54 -07:00
Exploring more
==============
* Have a look at our [Basic Tutorial](http://learn.getgrav.org/basics/basic-tutorial)
2014-08-11 13:01:11 -05:00
* Dive into more [advanced](http://learn.getgrav.org/advanced) functions
2014-08-11 10:49:54 -07:00
License
=======
See [LICENSE](LICENSE)