From ec27470d5a9c31883c556b474f730ebd0acfdee4 Mon Sep 17 00:00:00 2001
From: Kubat <mael.martin31@gmail.com>
Date: Mon, 21 Sep 2020 15:14:54 +0200
Subject: [PATCH] MISC: Doc update

- update README.md
- update CONTRIBUTING.md / CONTRIBUTORS
- lkt manpage
- update changelog
---
 CHANGELOG                    | 18 ++++++++++++++++++
 CONTRIBUTING.md              | 28 ++++++++++++++++++++++++++++
 CONTRIBUTING => CONTRIBUTORS |  0
 LICENSE                      |  6 +++---
 README.md                    | 13 +++++++------
 man/lkt.template             |  4 ++--
 6 files changed, 58 insertions(+), 11 deletions(-)
 create mode 100644 CONTRIBUTING.md
 rename CONTRIBUTING => CONTRIBUTORS (100%)

diff --git a/CHANGELOG b/CHANGELOG
index c487b729..c7ec8185 100644
--- a/CHANGELOG
+++ b/CHANGELOG
@@ -1,3 +1,21 @@
+# Next
+
+- Add the download and build dependencies script, whith its option in the
+  configure script
+- Bug fix: broken stop and clear
+- Bug fix: broken insert
+- More separation between modules and lektord's source code
+
+# v2.0
+
+- Change build toolchain to autotools
+- Asserts are enabled manually at runtime
+- Enable static modules and debug builds at compile time
+- Add a CI
+- Update documentation
+- Some refactor done
+- Some bug fixes…
+
 # v1.8-2
 
 - Add plt list to list all available playlists
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 00000000..f89aa7f0
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,28 @@
+# Contributing to Lektor
+
+Clone the [git repository](https://git.iiens.net/martin2018/lektor). Create a
+branch from master with the `git checkout -b dev-${pseudal}` command.
+
+Please, rebase regularly your branch on `master`.
+
+Please, add your name in the CONTRIBUTORS file. The format is `First name
+'Pseudal' FAMILY　NAME`. The licence is a modified version of the ISC licence
+to include this file (in short, a kind of MIT licence).
+
+## Building
+
+It is recommended to use the `../configure` method to build while in
+developpement. Also, prefere useing the `--with-depends` with the
+configuration, to use the fixed version.
+
+## Style style and the code
+
+Prefer using `__${name}` names for static variables and functions. Prefix the
+name of the file or folder in function names, e.g. `database_` or `command_`.
+
+For formating, use the `./scripts/astyle.bash` from the root of the project.
+You'll need [astyle](http://astyle.sourceforge.net/) for that. Note that the
+astyle step is a part of the CI/CD.
+
+You are encouraged to use the `./scripts/tags.bash` script to build the `ctags`
+and `cscope` database files to explore more easelly the project.
diff --git a/CONTRIBUTING b/CONTRIBUTORS
similarity index 100%
rename from CONTRIBUTING
rename to CONTRIBUTORS
diff --git a/LICENSE b/LICENSE
index bc67651d..061d50b1 100644
--- a/LICENSE
+++ b/LICENSE
@@ -1,8 +1,8 @@
-Copyright 2020 to Lektor contributors
+Copyright 2020 to Lektor contributors, refer to the CONTRIBUTORS file.
 
 Permission to use, copy, modify, and/or distribute this software for any purpose
-with or without fee is hereby granted, provided that the above copyright notice
-and this permission notice appear in all copies.
+with or without fee is hereby granted, provided that the above copyright notice,
+the CONTRIBUTORS file and this permission notice appear in all copies.
 
 THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
 REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
diff --git a/README.md b/README.md
index 3cb2f80b..a46b0ed9 100644
--- a/README.md
+++ b/README.md
@@ -41,9 +41,9 @@ configuration file:
 If you use the configure with the `--with-depends` option (needed on debian
 10), you will need the following dependencies:
 
-- the `curl` command line utility
-- the `wget` command line utility
-- the `git` command line utility
+- the [curl](https://curl.haxx.se/) command line utility
+- the [wget](https://www.gnu.org/software/wget/) command line utility
+- the [git](https://git-scm.com/) command line utility
 
 Note that because of the use of `curl` and `get`, building behind a proxy may
 be challenging.
@@ -60,12 +60,13 @@ make
 sudo make install
 
 # Config and run
-lkt adm conf > ~/.config/lektor/lektor.ini
 lektord
 ```
 
-The sqlite database will be created automatically if needed (i.e. on the first
-time you run lektord, you may need to restart lektord).
+The sqlite database and the config file will be created automatically if
+needed, i.e. on the first run. If you are upgrading lektor, the config might
+not be correct. You can delete the config file or use the `lkt admin config` to
+generate the config file again.
 
 If you are using special modules or are compiling lektor without static modules,
 you may set their **absolute path** inside the lektor's config file.
diff --git a/man/lkt.template b/man/lkt.template
index 20d33de3..3ae343ed 100644
--- a/man/lkt.template
+++ b/man/lkt.template
@@ -253,8 +253,8 @@ Here are some examples of queries:
 \fBtype OP\fP
 Select karas that are openings
 .TP
-\fBauthor k%\fP
-Select karas where the author begin with the character "k"
+\fBauthor kubat\fP
+Select karas where the author is "kubat"
 .PP
 
 .SH "EXAMPLES"
-- 
GitLab