README.rst 4.1 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091
  1. .. image:: https://api.travis-ci.org/wagtail/wagtail.svg?branch=master
  2. :target: https://travis-ci.org/wagtail/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://pypi.python.org/pypi/wagtail/
  7. .. image:: http://codecov.io/github/wagtail/wagtail/coverage.svg?branch=master
  8. :target: http://codecov.io/github/wagtail/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. * Excellent `test coverage <https://coveralls.io/r/torchbox/wagtail?branch=master>`_
  30. Find out more at `wagtail.io <http://wagtail.io/>`_.
  31. Getting started
  32. ~~~~~~~~~~~~~~~
  33. .. code-block:: sh
  34. pip install wagtail
  35. wagtail start mysite
  36. cd mysite
  37. python manage.py migrate
  38. python manage.py createsuperuser
  39. python manage.py runserver
  40. then sign in at http://127.0.0.1:8000/admin/
  41. For detailed installation and setup docs, see `docs.wagtail.io <http://docs.wagtail.io/>`_.
  42. Who's using it?
  43. ~~~~~~~~~~~~~~~
  44. `madewithwagtail.org <http://madewithwagtail.org>`_ lists some of the public Wagtail sites we know about; please `add your own <http://madewithwagtail.org/submit/>`_.
  45. Documentation
  46. ~~~~~~~~~~~~~
  47. `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.
  48. Community Support
  49. ~~~~~~~~~~~~~~~~~
  50. 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".
  51. 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>`_.
  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. Thanks
  56. ~~~~~~
  57. 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.
  58. .. image:: https://cdn.rawgit.com/wagtail/wagtail/master/.github/browserstack-logo.svg
  59. :target: https://www.browserstack.com/
  60. :width: 219 px
  61. Compatibility
  62. ~~~~~~~~~~~~~
  63. Wagtail supports Django 1.8.x, 1.10.x and 1.11.x, on Python 2.7, 3.4, 3.5 and 3.6. Supported database backends are PostgreSQL, MySQL and SQLite.
  64. Contributing
  65. ~~~~~~~~~~~~
  66. 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).
  67. 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.
  68. We also welcome translations for Wagtail's interface. Translation work should be submitted through `Transifex <https://www.transifex.com/projects/p/wagtail/>`_.