Commit 1209fa79 authored by David Seaward's avatar David Seaward

tidy README and copyright notice

parent d334dc7b
Purist account manager
======================
A Django site for account registration and management for Puri.st
A Django site for account registration and management for Purist
services. In particular, user registration creates an LDAP user,
which is used for authentication by other services.
......@@ -48,7 +48,8 @@ Setup
* Hook up system service (i.e. systemd, supervisord...) to runserver
directive (`manage.py runserver`)
For more options and details see <https://docs.djangoproject.com/en/1.11/#the-development-process>
For more options and details see
<https://docs.djangoproject.com/en/1.11/#the-development-process>
Migrations
----------
......@@ -71,33 +72,23 @@ not when running existing migrations (`migrate`).
Usage
-----
* Start Django site
* Start with system service, or
* `./manage.py runserver --settings=purist_account.settings_local`
* Visit <https://example.com> and follow login and/or register links
* Start Django site as system service, or with `./manage.py runserver`
* Visit <https://example.com/account> and follow login and/or
registration links
License
Sharing
-------
Purist account manager, for registration and account management <br />
Copyright 2017 Purism SPC and contributors <br />
SPDX-License-Identifier: GPL-3.0+
Puri.st account manager, a Django site for account registration and management
Copyright (C) 2017 Purism and contributors
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
Shared under GPLv3-or-later, see [COPYING.md](COPYING.md) for details.
Contributions under the same terms are welcome.
Also includes code portions from:
* https://github.com/yourcelf/django-registration-defaults (Copyright 2010 Charlie DeTar, Expat/MIT)
* https://github.com/asyd/pyldap_orm/blob/master/pyldap_orm/controls.py (Copyright 2016 Bruno Bonfils, Apache 2.0)
* https://github.com/yourcelf/django-registration-defaults
(Copyright 2010 Charlie DeTar, Expat/MIT)
* https://github.com/asyd/pyldap_orm/blob/master/pyldap_orm/controls.py
(Copyright 2016 Bruno Bonfils, Apache 2.0)
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
#
# Puri.st account site documentation build configuration file, created by
# Purist account site documentation build configuration file, created by
# sphinx-quickstart on Tue Mar 7 16:17:28 2017.
#
# This file is execfile()d with the current directory set to its
......@@ -56,9 +56,9 @@ source_suffix = '.rst'
master_doc = 'index'
# General information about the project.
project = 'Puri.st account site'
copyright = '2017, Purism and contributors'
author = 'Purism and contributors'
project = 'Purist account manager'
copyright = '2017 Purism SPC and contributors'
author = 'Purism SPC and contributors'
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
......@@ -137,8 +137,8 @@ latex_elements = {
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
(master_doc, 'Puristaccountsite.tex', 'Puri.st account site Documentation',
'Purism and contributors', 'manual'),
(master_doc, 'Puristaccountsite.tex', 'Purist account manager documentation',
'Purism SPC and contributors', 'manual'),
]
......@@ -147,7 +147,7 @@ latex_documents = [
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
(master_doc, 'puristaccountsite', 'Puri.st account site Documentation',
(master_doc, 'puristaccountsite', 'Purist account manager documentation',
[author], 1)
]
......@@ -158,9 +158,9 @@ man_pages = [
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
(master_doc, 'Puristaccountsite', 'Puri.st account site Documentation',
author, 'Puristaccountsite', 'A Django site for account registration and '
'management for Puri.st services.', 'Miscellaneous'),
(master_doc, 'Puristaccountsite', 'Purist account manager documentation',
author, 'Puristaccountsite', 'Account registration and management for '
'Purist services.', 'Miscellaneous'),
]
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment