Skip to content
Extraits de code Groupes Projets
Vérifiée Valider ec27470d rédigé par Kubat's avatar Kubat
Parcourir les fichiers

MISC: Doc update

- update README.md
- update CONTRIBUTING.md / CONTRIBUTORS
- lkt manpage
- update changelog
parent ae15c20e
Aucune branche associée trouvée
Aucune étiquette associée trouvée
1 requête de fusion!118Bug fixes & DL dependencies when specified
# 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
......
# 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.
Fichier déplacé
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
......
......@@ -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.
......
......@@ -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"
......
0% Chargement en cours ou .
You are about to add 0 people to the discussion. Proceed with caution.
Terminez d'abord l'édition de ce message.
Veuillez vous inscrire ou vous pour commenter