0
0
mirror of https://github.com/wagtail/wagtail.git synced 2024-11-24 01:57:32 +01:00
wagtail/README.rst

55 lines
2.7 KiB
ReStructuredText
Raw Normal View History

.. image:: https://travis-ci.org/torchbox/wagtail.png?branch=master
:target: https://travis-ci.org/torchbox/wagtail
2014-06-19 15:17:27 +02:00
.. image:: https://coveralls.io/repos/torchbox/wagtail/badge.png?branch=master&zxcv1
:target: https://coveralls.io/r/torchbox/wagtail?branch=master
2014-05-29 10:47:21 +02:00
.. image:: https://pypip.in/v/wagtail/badge.png?zxcv
2014-02-17 18:15:03 +01:00
:target: https://crate.io/packages/wagtail/
2014-02-07 15:35:12 +01:00
Wagtail CMS
===========
2014-02-14 14:34:01 +01:00
.. image:: http://i.imgur.com/4pbWQ35.png
2014-02-13 12:41:56 +01:00
Wagtail is a Django content management system built originally for the `Royal College of Art <http://www.rca.ac.uk/>`_ and focused on flexibility and user experience. Its features include:
* A fast, attractive editor interface
* Complete control over design with standard Django templates
* Configure content types through standard Django models
* Tightly integrated search (with an `Elasticsearch <http://www.elasticsearch.org/>`_ backend for production)
* Strong document and image management
* Wide support for embedded content
2014-02-13 13:08:43 +01:00
* Simple, configurable permissions
* Support for tree-based content organisation
2014-02-13 12:41:56 +01:00
* Optional preview->submit->approve workflow
* Fast out of the box. `Varnish <https://www.varnish-cache.org/>`_-friendly if you need it
2014-06-02 14:49:10 +02:00
* Excellent test coverage
2014-02-13 12:41:56 +01:00
2014-05-23 11:22:32 +02:00
Find out more at `wagtail.io <http://wagtail.io/>`_.
2014-02-13 17:56:38 +01:00
Got a question? Ask it on our `Google Group <https://groups.google.com/forum/#!forum/wagtail>`_.
Getting started
~~~~~~~~~~~~~~~
* To get you up and running quickly, we've provided a demonstration site with all the configuration in place, at `github.com/torchbox/wagtaildemo <https://github.com/torchbox/wagtaildemo/>`_; see the `README <https://github.com/torchbox/wagtaildemo/blob/master/README.md>`_ for installation instructions.
* See the `Getting Started <http://wagtail.readthedocs.org/en/latest/gettingstarted.html#getting-started>`_ docs for installation (with the demo app) on a fresh Debian/Ubuntu box with production-ready dependencies, on OS X and on a Vagrant box.
* `Serafeim Papastefanos <https://github.com/spapas>`_ has written a `tutorial <http://spapas.github.io/2014/02/13/wagtail-tutorial/>`_ with all the steps to build a simple Wagtail site from scratch.
2014-05-23 11:22:32 +02:00
Documentation
~~~~~~~~~~~~~
2014-05-23 12:49:39 +02:00
Available at `wagtail.readthedocs.org <http://wagtail.readthedocs.org/>`_. and always being updated.
2014-05-23 11:22:32 +02:00
Compatibility
~~~~~~~~~~~~~
2014-05-23 11:22:49 +02:00
Wagtail supports Django 1.6.2+ on Python 2.6 and 2.7. Django 1.7 and Python 3 support are in progress.
2014-05-23 11:22:32 +02:00
Contributing
~~~~~~~~~~~~
2014-07-02 12:40:22 +02:00
If you're a Python or Django developer, fork the repo and get stuck in!
2014-07-02 12:41:38 +02:00
We suggest you start by checking the `Help develop me! <https://github.com/torchbox/wagtail/issues?labels=Help+develop+me%21>`_ label.
2014-07-02 12:40:22 +02:00
2014-07-02 12:44:39 +02:00
Send us a useful pull request and we'll post you a `t-shirt <https://twitter.com/WagtailCMS/status/432166799464210432/photo/1>`_.
2014-05-23 11:22:32 +02:00