diff --git a/CONTRIBUTING.md b/.github/CONTRIBUTING.md similarity index 100% rename from CONTRIBUTING.md rename to .github/CONTRIBUTING.md diff --git a/.github/wagtail-screenshot-with-browser.png b/.github/wagtail-screenshot-with-browser.png new file mode 100644 index 0000000000..f646fe1674 Binary files /dev/null and b/.github/wagtail-screenshot-with-browser.png differ diff --git a/.github/wagtail.svg b/.github/wagtail.svg new file mode 100644 index 0000000000..84b04b9b6c --- /dev/null +++ b/.github/wagtail.svg @@ -0,0 +1,64 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/MANIFEST.in b/MANIFEST.in index ddd18ce9c8..5d7681b9c8 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -1,4 +1,4 @@ -include LICENSE *.rst *.txt +include LICENSE *.rst *.txt *.md graft wagtail prune wagtail/wagtailadmin/static_src global-exclude __pycache__ diff --git a/README.md b/README.md new file mode 100644 index 0000000000..37da705a8a --- /dev/null +++ b/README.md @@ -0,0 +1,92 @@ +

+ Wagtail +
+
+

+ +Wagtail is an open source content management system built on Django, with a strong community and commercial support. It's focused on user experience, and offers precise control for designers and developers. + +![Wagtail screenshot](https://cdn.rawgit.com/wagtail/wagtail/master/.github/wagtail-screenshot-with-browser.png) + +### Features + +* A fast, attractive interface for authors +* Complete control over front-end design and structure +* Scales to millions of pages and thousands of editors +* Fast out of the box, cache-friendly when you need it +* Content API for 'headless' sites with de-coupled front-end +* Runs on a Raspberry Pi or a multi-datacenter cloud platform +* StreamField encourages flexible content without compromising structure +* Powerful, integrated search, using Elasticsearch or PostgreSQL +* Excellent support for images and embedded content +* Multi-site and multi-language ready +* Embraces and extends Django + +Find out more at [wagtail.io](https://wagtail.io/). + +### Getting started + +Wagtail works with Python 3, on any platform. + +``` + pip install wagtail + wagtail start mysite + cd mysite + python manage.py migrate + python manage.py createsuperuser + python manage.py runserver +``` + +For detailed installation and setup docs, see [docs.wagtail.io](http://docs.wagtail.io/). + +### Who’s using it? + +Wagtail is used by NASA, Google, Oxfam, the NHS, Mozilla, MIT, the Red Cross, Salesforce, NBC, BMW, and the US and UK governments. Add your own Wagtail site to [madewithwagtail.org](http://madewithwagtail.org). + +### 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. + +### Compatibility + +Wagtail supports: + +* Django 1.11.x and 2.0 +* Python 3.4, 3.5 and 3.6 +* PostgreSQL, MySQL and SQLite as database backends + +Previous versions of Wagtail (1.13 and earlier) additionally supported Python 2.7. + +--- + +### 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 "wagtail". + +For topics and discussions that do not fit Stack Overflow's question and answer format, we have a [Slack workspace](https://github.com/wagtail/wagtail/wiki/Slack) and a [Wagtail Support mailing list](https://groups.google.com/forum/#!forum/wagtail). + +We maintain a curated list of third party packages, articles and other resources at [Awesome Wagtail](https://github.com/springload/awesome-wagtail). + +### Commercial Support + +Wagtail is sponsored by [Torchbox](https://torchbox.com/). If you need help implementing or hosting Wagtail, please contact us: hello@torchbox.com. See also [madewithwagtail.org/developers/](https://madewithwagtail.org/developers/) for expert Wagtail developers around the world. + +### 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). + +You might like to start by reviewing the [contributing guidelines](http://docs.wagtail.io/en/latest/contributing/index.html) and checking issues with the [good first issue](https://github.com/wagtail/wagtail/labels/good%20first%20issue) label. + +We also welcome translations for Wagtail's interface. Translation work should be submitted through [Transifex](https://www.transifex.com/projects/p/wagtail/). + +### 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. + +[![Browserstack](https://cdn.rawgit.com/wagtail/wagtail/master/.github/browserstack-logo.svg)](https://www.browserstack.com/) + +[![Build Status](https://api.travis-ci.org/wagtail/wagtail.svg?branch=master)](https://travis-ci.org/wagtail/wagtail) +[![License](https://img.shields.io/badge/license-BSD-blue.svg)](https://opensource.org/licenses/BSD-3-Clause) +[![Version](https://img.shields.io/pypi/v/wagtail.svg)](https://pypi.python.org/pypi/wagtail/) +[![Coverage](http://codecov.io/github/wagtail/wagtail/coverage.svg?branch=master)](http://codecov.io/github/wagtail/wagtail?branch=master) +[![Slack](https://wagtail-slack.now.sh/badge.svg)](https://wagtail-slack.now.sh) \ No newline at end of file diff --git a/README.rst b/README.rst deleted file mode 100644 index fb641aa979..0000000000 --- a/README.rst +++ /dev/null @@ -1,91 +0,0 @@ -.. 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 - - -Wagtail CMS -=========== - -Wagtail is a content management system built on Django. It's focused on user experience, -and offers precise control for designers and developers. - -.. image:: http://i.imgur.com/hSVerKq.jpg - :width: 728 px - -Features -~~~~~~~~ - -* A fast, attractive interface for authors and editors -* 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 -* Strong document and image management -* Wide support for embedded content -* Straightforward integration with existing Django apps -* Simple, configurable permissions -* Workflow support -* An extensible `form builder `_ -* Multi-site and multi-language support -* Excellent `test coverage `_ - -Find out more at `wagtail.io `_. - -Getting started -~~~~~~~~~~~~~~~ - -.. code-block:: sh - - pip install wagtail - wagtail start mysite - cd mysite - python manage.py migrate - python manage.py createsuperuser - python manage.py runserver - -then sign in at http://127.0.0.1:8000/admin/ - -For detailed installation and setup docs, see `docs.wagtail.io `_. - -Who's using it? -~~~~~~~~~~~~~~~ -`madewithwagtail.org `_ lists some of the public Wagtail sites we know about; please `add your own `_. - -Documentation -~~~~~~~~~~~~~ -`docs.wagtail.io `_ is the full reference for Wagtail, and includes guides for developers, designers and editors, alongside release notes and our roadmap. - -Community Support -~~~~~~~~~~~~~~~~~ -There is an active community of Wagtail users and developers responding to questions on `Stack Overflow `_. When posting questions, please read Stack Overflow's advice on `how to ask questions `_ and remember to tag your question with "wagtail". - -For topics and discussions that do not fit Stack Overflow's question-and-answer format, there is also a `Wagtail Support mailing list `_ and a `Slack workspace `_. - -Commercial Support -~~~~~~~~~~~~~~~~~~ -Wagtail is sponsored by `Torchbox `_. If you need help implementing or hosting Wagtail, please contact us: hello@torchbox.com. - -Thanks -~~~~~~ -We thank `BrowserStack `_, 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 - -Compatibility -~~~~~~~~~~~~~ -Wagtail supports Django 1.11.x and 2.0 on Python 3.4, 3.5 and 3.6. Supported database backends are PostgreSQL, MySQL and SQLite. - -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). - -You might like to start by reviewing the `contributing guidelines `_ and checking issues with the `good first issue `_ label. - -We also welcome translations for Wagtail's interface. Translation work should be submitted through `Transifex `_. diff --git a/setup.py b/setup.py index 8179939c49..a8cdb24070 100755 --- a/setup.py +++ b/setup.py @@ -67,14 +67,19 @@ documentation_extras = [ setup( name='wagtail', version=__version__, - description='A Django content management system focused on flexibility and user experience', + description='A Django content management system.', author='Wagtail core team + contributors', author_email='hello@wagtail.io', # For support queries, please see http://docs.wagtail.io/en/stable/support.html url='http://wagtail.io/', packages=find_packages(), include_package_data=True, license='BSD', - long_description=open('README.rst').read(), + long_description="Wagtail is an open source content management \ +system built on Django, with a strong community and commercial support. \ +It’s focused on user experience, and offers precise control for \ +designers and developers.\n\n\ +For more details, see https://wagtail.io, http://docs.wagtail.io and \ +https://github.com/wagtail/wagtail/.", classifiers=[ 'Development Status :: 5 - Production/Stable', 'Environment :: Web Environment',