README.rst 3.6 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182
  1. .. image:: https://api.travis-ci.org/torchbox/wagtail.svg?branch=master
  2. :target: https://travis-ci.org/torchbox/wagtail
  3. .. image:: https://img.shields.io/pypi/l/wagtail.svg
  4. :target: https://pypi.python.org/pypi/wagtail/
  5. .. image:: https://img.shields.io/pypi/v/wagtail.svg
  6. :target: https://crate.io/packages/wagtail/
  7. .. image:: https://coveralls.io/repos/torchbox/wagtail/badge.svg?branch=master
  8. :target: https://coveralls.io/r/torchbox/wagtail?branch=master
  9. Wagtail CMS
  10. ===========
  11. Wagtail is a content management system built on Django. It's focused on user experience,
  12. and offers precise control for designers and developers.
  13. .. image:: http://i.imgur.com/U5MDa0l.jpg
  14. :width: 728 px
  15. Features
  16. ~~~~~~~~
  17. * A fast, attractive interface for authors and editors
  18. * Complete control over design with standard Django templates
  19. * Configure content types through standard Django models
  20. * Fast out of the box. Cache-friendly if you need it
  21. * Tightly integrated search
  22. * Strong document and image management
  23. * Wide support for embedded content
  24. * Straightforward integration with existing Django apps
  25. * Simple, configurable permissions
  26. * Workflow support
  27. * An extensible `form builder <http://docs.wagtail.io/en/latest/reference/contrib/forms.html>`_
  28. * Multi-site and multi-language support
  29. * Optional `static site generation <http://docs.wagtail.io/en/latest/reference/contrib/staticsitegen.html>`_
  30. * Excellent `test coverage <https://coveralls.io/r/torchbox/wagtail?branch=master>`_
  31. Find out more at `wagtail.io <http://wagtail.io/>`_.
  32. Getting started
  33. ~~~~~~~~~~~~~~~
  34. .. code-block::
  35. pip install wagtail
  36. wagtail start mysite
  37. cd mysite
  38. python manage.py migrate
  39. python manage.py createsuperuser
  40. python manage.py runserver
  41. then sign in at http://127.0.0.1:8000/admin/
  42. For detailed installation and setup docs, see `docs.wagtail.io <http://docs.wagtail.io/>`_.
  43. Who's using it?
  44. ~~~~~~~~~~~~~~~
  45. `madewithwagtail.org <http://madewithwagtail.org>`_ lists some of the public Wagtail sites we know about; please `add your own <http://madewithwagtail.org/submit/>`_.
  46. Documentation
  47. ~~~~~~~~~~~~~
  48. `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.
  49. Community Support
  50. ~~~~~~~~~~~~~~~~~
  51. Ask your questions on our `Wagtail support group <https://groups.google.com/forum/#!forum/wagtail>`_.
  52. Commercial Support
  53. ~~~~~~~~~~~~~~~~~~
  54. Wagtail is sponsored by `Torchbox <https://torchbox.com/>`_. If you need help implementing or hosting Wagtail, please contact us: hello@torchbox.com.
  55. Compatibility
  56. ~~~~~~~~~~~~~
  57. Wagtail supports Django 1.7.1+ on Python 2.7, 3.3, 3.4 and 3.5. Supported database backends are PostgreSQL, MySQL and SQLite.
  58. Contributing
  59. ~~~~~~~~~~~~
  60. 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).
  61. You might like to start by reviewing the `coding guidelines <http://docs.wagtail.io/en/latest/contributing/developing.html#coding-guidelines>`_ and checking issues with the `Ready to develop <https://github.com/torchbox/wagtail/issues?q=is%3Aopen+is%3Aissue+label%3A%22Ready+to+develop%21%22>`_ label.
  62. Send us a particularly useful pull request and we'll post you a `t-shirt <https://twitter.com/WagtailCMS/status/432166799464210432/photo/1>`_.
  63. We also welcome translations for Wagtail's interface. Translation work should be submitted through `Transifex <https://www.transifex.com/projects/p/wagtail/>`_.