From 728cf65703af16bb0e6a8ef491015d4b8e2395e1 Mon Sep 17 00:00:00 2001 From: Pavel 'LEdoian' Turinsky Date: Wed, 22 Dec 2021 05:23:46 +0100 Subject: [PATCH] Extend the readme to include usual parts --- README.md | 41 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 41 insertions(+) diff --git a/README.md b/README.md index e8ec4be..6aa0d21 100644 --- a/README.md +++ b/README.md @@ -6,4 +6,45 @@ This is a simple Django project to create and share lists of wishes. There are t 1. Christmas. Every time anybody asks me what I want for Christmas, I am totally unable to answer that. 2. The need to test various Django extensions and features before production deployment. +Also: Simple TODO lists. They are lists anyway, so reusing this project seems +fine. But they will only work as a plain list, no special features. +Contributing and support +--- +Code lives at +Send questions and patches to + +Currently there is no documentation :-/ + +Installing +--- +TODO :-/ + +Licence +--- +The _code_ is distributed under WTFPL v2.0. On the other hand, documentation +(including this readme) is not; its licence is not yet decided. + +Parts of the code are autogenerated by +[Django](https://www.djangoproject.com/), not by me. IANAL, so I cannot tell +the specific condition of sharing this code. (However, they do not seem to care +about those bits…) + +### Rationale + +I would like to promote free software and especially empower any user of the +software to be able to access the source code. Therefore, I _recommend_ anyone +to link to the source code. + +However, this is a playground for my experiments with Django that I might want +to copy-paste to other projects, without worries. I also want to make sure that +others can do the same, since there probably will be nothing special in the +code, just some tricks that may actually work. + +I _might_ want to change the licence in the future. It will _probably_ be +permissive, too. + +The documentation in this project, however, feels a lot like an original work, +so it should get a reasonable licence with reasonable conditions (i.e. at least +something like CC BY, probably stricter). I still want anyone to be able to +read and contribute the docs, but it should not get easily stealable.