wagtail/README.rst

68 wiersze
3.6 KiB
ReStructuredText
Czysty Zwykły widok Historia

.. image:: https://travis-ci.org/torchbox/wagtail.png?branch=master
:target: https://travis-ci.org/torchbox/wagtail
2014-06-19 13:17:27 +00: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 08:47:21 +00:00
.. image:: https://pypip.in/v/wagtail/badge.png?zxcv
2014-02-17 17:15:03 +00:00
:target: https://crate.io/packages/wagtail/
2014-02-07 14:35:12 +00:00
Wagtail CMS
===========
2014-02-14 13:34:01 +00:00
.. image:: http://i.imgur.com/4pbWQ35.png
2014-02-13 11:41:56 +00: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 12:08:43 +00:00
* Simple, configurable permissions
* Support for tree-based content organisation
2014-02-13 11:41:56 +00:00
* Optional preview->submit->approve workflow
* Fast out of the box. `Varnish <https://www.varnish-cache.org/>`_-friendly if you need it
* A simple `form builder <http://docs.wagtail.io/en/latest/core_components/form_builder.html>`_
* Optional `static site generation <http://docs.wagtail.io/en/latest/contrib_components/static_site_generation.html>`_
2014-07-02 16:50:03 +00:00
* Excellent `test coverage <https://coveralls.io/r/torchbox/wagtail?branch=master>`_
2014-02-13 11:41:56 +00:00
2014-05-23 09:22:32 +00:00
Find out more at `wagtail.io <http://wagtail.io/>`_.
2014-02-13 16:56:38 +00:00
Got a question? Ask it on our `Google Group <https://groups.google.com/forum/#!forum/wagtail>`_.
2014-09-16 14:45:22 +00:00
Who's using it?
~~~~~~~~~~~~~~~
We've a list of public Wagtail sites here: https://github.com/torchbox/wagtail/wiki/Public-Wagtail-sites
Got one of your own? Feel free to add it!
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.
2014-09-12 09:19:39 +00:00
* See the `Getting Started <http://wagtail.readthedocs.org/en/latest/getting_started/installation.html>`_ 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-07-03 10:06:43 +00:00
* We've also provided a skeletal django-template to get started on a blank site: https://github.com/torchbox/wagtail-template
2014-05-23 09:22:32 +00:00
Documentation
~~~~~~~~~~~~~
Available at `wagtail.readthedocs.org <http://wagtail.readthedocs.org/>`_ and always being updated.
2014-05-23 09:22:32 +00:00
Compatibility
~~~~~~~~~~~~~
2014-09-12 09:16:19 +00:00
Wagtail supports Django 1.6.2+ and 1.7.0+ on Python 2.6, 2.7, 3.2, 3.3 and 3.4.
Wagtail's dependencies are summarised at `requirements.io <https://requires.io/github/torchbox/wagtail/requirements>`_.
2014-05-23 09:22:32 +00:00
Contributing
~~~~~~~~~~~~
If you're a Python or Django developer, fork the repo and get stuck in!
2014-07-02 10:40:22 +00:00
We suggest you start by checking the `Help develop me! <https://github.com/torchbox/wagtail/issues?labels=Help+develop+me%21>`_ label and the `coding guidelines <http://wagtail.readthedocs.org/en/latest/howto/contributing.html#coding-guidelines>`_.
2014-07-02 10:40:22 +00:00
2014-07-02 10:44:39 +00: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 09:22:32 +00:00
We also welcome `translations <http://wagtail.readthedocs.org/en/latest/howto/contributing.html#translations>`_ for Wagtail's interface.