From f62752215c230ab72f2b1d0b80dd722dabeb7e36 Mon Sep 17 00:00:00 2001 From: Tom Dyson Date: Thu, 14 May 2015 12:15:16 +0100 Subject: [PATCH] Project README updates MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit modern badges, new screenshot, updated feature list, simplified ‘getting started’. --- README.rst | 77 ++++++++++++++++++++++++++---------------------------- 1 file changed, 37 insertions(+), 40 deletions(-) diff --git a/README.rst b/README.rst index b354d2138..a8c6e356d 100644 --- a/README.rst +++ b/README.rst @@ -1,80 +1,77 @@ -.. image:: https://travis-ci.org/torchbox/wagtail.png?branch=master +.. image:: https://api.travis-ci.org/torchbox/wagtail.svg?branch=master :target: https://travis-ci.org/torchbox/wagtail - -.. image:: https://coveralls.io/repos/torchbox/wagtail/badge.png?branch=master&zxcv1 - :target: https://coveralls.io/r/torchbox/wagtail?branch=master - -.. image:: https://pypip.in/v/wagtail/badge.png?zxcv +.. 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://crate.io/packages/wagtail/ +.. image:: https://coveralls.io/repos/torchbox/wagtail/badge.svg?branch=master + :target: https://coveralls.io/r/torchbox/wagtail?branch=master Wagtail CMS =========== -.. image:: http://i.imgur.com/1OJwg4m.png +.. image:: http://i.imgur.com/U5MDa0l.jpg -Wagtail is a Django content management system built originally for the `Royal College of Art `_ and focused on flexibility and user experience. Its features include: +Wagtail is a content management system built on Django. It's focused on user experience, and precise control for designers and developers. Wagtail's features include: -* A fast, attractive editor interface +* A fast, attractive interface for authors and editors * Complete control over design with standard Django templates * Configure content types through standard Django models -* Tightly integrated search (with an `Elasticsearch `_ backend for production) +* Fast out of the box. Cache-friendly if you need it +* Tightly integrated search * Strong document and image management * Wide support for embedded content +* Straightforward integration with existing Django apps * Simple, configurable permissions -* Support for tree-based content organisation -* Optional preview->submit->approve workflow -* Fast out of the box. `Varnish `_-friendly if you need it -* A simple `form builder `_ +* Workflow support +* An extensible `form builder `_ +* Multi-site and multi-language support * Optional `static site generation `_ * Excellent `test coverage `_ Find out more at `wagtail.io `_. +Getting started +~~~~~~~~~~~~~~~ + .. code-block:: bash + + pip install wagtail + wagtail start mysite + cd mysite + python manage.py migrate + python manage.py createsuperuser + python manage.py runserver + +Sign in at http://127.0.0.1:8000/admin/ + +For detailed installation and setup docs, see `docs.wagtail.io `_. 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 `_; see the `README `_ for installation instructions. -* See the `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 `_ has written a `tutorial `_ with all the steps to build a simple Wagtail site from scratch. -* We've also provided a skeletal django-template to get started on a blank site: https://github.com/torchbox/wagtail-template +`madewithwagtail.org `_ lists some of the public Wagtail sites we know about; please `add your own `_. Documentation ~~~~~~~~~~~~~ -Available at `docs.wagtail.io `_ and always being updated. +`docs.wagtail.io `_ is the full reference for Wagtail, and includes guides for developers, designers and editors, alongside release notes and our roadmap. - -Need Support? -~~~~~~~~~~~~~~~ +Community Support +~~~~~~~~~~~~~~~~~ Ask your questions on our `Wagtail support group `_. - Commercial Support ~~~~~~~~~~~~~~~~~~ Wagtail is sponsored by `Torchbox `_. If you need help implementing or hosting Wagtail, please contact us: hello@torchbox.com. - Compatibility ~~~~~~~~~~~~~ -Wagtail supports Django 1.7.1+ on Python 2.7, 3.3 and 3.4. - -Wagtail's dependencies are summarised at `requirements.io `_. - +Wagtail supports Django 1.7.1+ on Python 2.7, 3.3 and 3.4. Supported database backends are PostgreSQL, MySQL and SQLite. Contributing ~~~~~~~~~~~~ -If you're a Python or Django developer, fork the repo and get stuck in! +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). -We suggest you start by checking the `Ready to develop! `_ label and the `coding guidelines `_. +You might like to start by reviewing the `coding guidelines `_ and checking issues with the `Ready to develop `_ label. -Send us a useful pull request and we'll post you a `t-shirt `_. +Send us a particularly useful pull request and we'll post you a `t-shirt `_. We also welcome translations for Wagtail's interface. Translation work should be submitted through `Transifex `_. - -We run a separate Wagtail developers group here: https://groups.google.com/forum/#!forum/wagtail-developers please not that this is not for support requests.