0
0
mirror of https://github.com/wagtail/wagtail.git synced 2024-11-29 09:33:54 +01:00
wagtail/README.rst

92 lines
4.1 KiB
ReStructuredText
Raw Normal View History

.. image:: https://api.travis-ci.org/wagtail/wagtail.svg?branch=master
:target: https://travis-ci.org/wagtail/wagtail
.. image:: https://img.shields.io/pypi/l/wagtail.svg
:target: https://pypi.python.org/pypi/wagtail/
.. image:: https://img.shields.io/pypi/v/wagtail.svg
:target: https://pypi.python.org/pypi/wagtail/
.. image:: http://codecov.io/github/wagtail/wagtail/coverage.svg?branch=master
:target: http://codecov.io/github/wagtail/wagtail?branch=master
2014-02-17 18:15:03 +01:00
2014-02-07 15:35:12 +01:00
Wagtail CMS
===========
2015-06-04 11:15:30 +02:00
Wagtail is a content management system built on Django. It's focused on user experience,
and offers precise control for designers and developers.
2015-05-14 13:31:55 +02:00
2017-08-01 14:39:54 +02:00
.. image:: http://i.imgur.com/hSVerKq.jpg
2015-05-14 13:31:55 +02:00
:width: 728 px
2014-02-14 14:34:01 +01:00
2015-05-14 13:31:55 +02:00
Features
~~~~~~~~
2014-02-13 12:41:56 +01:00
* A fast, attractive interface for authors and editors
2014-02-13 12:41:56 +01:00
* Complete control over design with standard Django templates
* Configure content types through standard Django models
* Fast out of the box. Cache-friendly if you need it
* Tightly integrated search
2014-02-13 12:41:56 +01:00
* Strong document and image management
* Wide support for embedded content
* Straightforward integration with existing Django apps
2014-02-13 13:08:43 +01:00
* Simple, configurable permissions
* Workflow support
* An extensible `form builder <http://docs.wagtail.io/en/latest/reference/contrib/forms/index.html>`_
* Multi-site and multi-language support
2014-07-02 18:50:03 +02:00
* Excellent `test coverage <https://coveralls.io/r/torchbox/wagtail?branch=master>`_
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
Getting started
2014-09-16 16:45:22 +02:00
~~~~~~~~~~~~~~~
2016-01-06 13:51:53 +01:00
.. code-block:: sh
pip install wagtail
wagtail start mysite
cd mysite
python manage.py migrate
python manage.py createsuperuser
python manage.py runserver
2014-09-16 16:45:22 +02:00
2015-05-14 13:31:55 +02:00
then sign in at http://127.0.0.1:8000/admin/
2014-09-16 16:45:22 +02:00
For detailed installation and setup docs, see `docs.wagtail.io <http://docs.wagtail.io/>`_.
Who's using it?
~~~~~~~~~~~~~~~
`madewithwagtail.org <http://madewithwagtail.org>`_ lists some of the public Wagtail sites we know about; please `add your own <http://madewithwagtail.org/submit/>`_.
2014-05-23 11:22:32 +02:00
Documentation
~~~~~~~~~~~~~
`docs.wagtail.io <http://docs.wagtail.io/>`_ is the full reference for Wagtail, and includes guides for developers, designers and editors, alongside release notes and our roadmap.
2015-02-19 10:16:43 +01:00
Community Support
~~~~~~~~~~~~~~~~~
There is an active community of Wagtail users and developers responding to questions on `Stack Overflow <http://stackoverflow.com/questions/tagged/wagtail>`_. When posting questions, please read Stack Overflow's advice on `how to ask questions <http://stackoverflow.com/help/how-to-ask>`_ and remember to tag your question with "wagtail".
2017-11-23 18:23:18 +01:00
For topics and discussions that do not fit Stack Overflow's question-and-answer format, there is also a `Wagtail Support mailing list <https://groups.google.com/forum/#!forum/wagtail>`_ and a `Slack workspace <https://github.com/wagtail/wagtail/wiki/Slack>`_.
2015-02-19 10:16:43 +01:00
Commercial Support
~~~~~~~~~~~~~~~~~~
Wagtail is sponsored by `Torchbox <https://torchbox.com/>`_. If you need help implementing or hosting Wagtail, please contact us: hello@torchbox.com.
Thanks
~~~~~~
We thank `BrowserStack <https://www.browserstack.com/>`_, who provide the project with free access to their live web-based browser testing tool, and automated Selenium cloud testing.
.. image:: https://cdn.rawgit.com/wagtail/wagtail/master/.github/browserstack-logo.svg
:target: https://www.browserstack.com/
:width: 219 px
2014-05-23 11:22:32 +02:00
Compatibility
~~~~~~~~~~~~~
Wagtail supports Django 1.11.x on Python 3.4, 3.5 and 3.6. Supported database backends are PostgreSQL, MySQL and SQLite.
2015-02-19 10:16:43 +01:00
Contributing
~~~~~~~~~~~~
If you're a Python or Django developer, fork the repo and get stuck in! We run a separate group for developers of Wagtail itself at https://groups.google.com/forum/#!forum/wagtail-developers (please note that this is not for support requests).
2014-07-02 12:40:22 +02:00
You might like to start by reviewing the `contributing guidelines <http://docs.wagtail.io/en/latest/contributing/index.html>`_ and checking issues with the `difficulty:Easy <https://github.com/wagtail/wagtail/labels/difficulty%3AEasy>`_ label.
2014-07-02 12:40:22 +02:00
We also welcome translations for Wagtail's interface. Translation work should be submitted through `Transifex <https://www.transifex.com/projects/p/wagtail/>`_.