From: Niki Roo Date: Fri, 5 Jul 2024 14:34:05 +0000 (+0200) Subject: README + readme/ + update X-Git-Url: https://git.nikiroo.be/?a=commitdiff_plain;h=0e123d789a7165ddc9e89d2e251462e0cfa999ce;p=template.git README + readme/ + update --- diff --git a/README.md b/README.md index 54b1092..6e8a762 100644 --- a/README.md +++ b/README.md @@ -16,3 +16,5 @@ Currently, those are available: * `c-tsttree`: Makefile adapted to submodule-ready C test projects * `java`: structure and Makefile for a java project +You can also find a `readme` directory with some sample README and changelog files for you to use. + diff --git a/c-master b/c-master index 8dd68dc..4ab67a0 160000 --- a/c-master +++ b/c-master @@ -1 +1 @@ -Subproject commit 8dd68dca3efcccbedbead331e8469aa5b07730cc +Subproject commit 4ab67a0be2aa19673623ca0cd2b433c6a125b48e diff --git a/java b/java index 811796d..a2871d1 160000 --- a/java +++ b/java @@ -1 +1 @@ -Subproject commit 811796db36e23c08496a84c302a4e3b5f0df469b +Subproject commit a2871d1368652ac4a639af955298a7f285862eba diff --git a/readme/README-fr.c.md b/readme/README-fr.c.md new file mode 100644 index 0000000..e379040 --- /dev/null +++ b/readme/README-fr.c.md @@ -0,0 +1,40 @@ +[English](README.md) Français + +# MyProgram + +Description courte. + +## Synopsis + +- `myprogram --help` + +## Description + +Description longue du programme. + +Possible de le faire en plusieurs paragraphes. + +## Options + +- **--help** (or **-h**): afficher la liste des options disponibles + +## Compilation + +Lancez simplement `make`. + +Vous pouvez aussi utiliser ces options : + +- `make doc`: préparer la documentation avec Doxygen (`doxygen` est requis) +- `make man`: préparer la man page (`pandoc` est requis) +- `make install PREFIX=/usr/local`: installer le programme (et le manuel si préparé précedemment) dans le PREFIX donné (par défaut, `/usr/local`) +- `make uninstall PREFIX=/usr/local`: désinstaller le programme (et le manuel) du PREFIX donné +- `make clear`: nettoyer les fichiers temporaires +- `make mrpropre`: nettoyer tout, y compris les binaires générés et la documentation +- `make test`: préparer les tests unitaires (la librairie `check` est requise) +- `make run-test`: démarrer les tests unitaires +- `make run-test-more`: démarrer les tests supplémentaires (possiblement très long) + +## Auteur + +MyProgram a été écrit par Niki Roo + diff --git a/readme/README-fr.java.md b/readme/README-fr.java.md new file mode 100644 index 0000000..853ea15 --- /dev/null +++ b/readme/README-fr.java.md @@ -0,0 +1,67 @@ +[English](README.md) Français + +# MyProgram + +Description courte. + +## Synopsis + +- `myprogram --help` + +## Description + +Description longue du programme. + +Possible de le faire en plusieurs paragraphes. + +## Options + +- **--help** (or **-h**): afficher la liste des options disponibles + +### Plateformes supportées + +Toute plateforme supportant Java 1.6 devrait suffire. + +Le programme a été testé sur Linux (Debian, Slackware et Ubuntu), MacOS X et Windows pour le moment, mais n'hésitez pas à nous informer si vous l'essayez sur un autre système. + +Si vous avez des difficultés pour le compiler avec une version supportée de Java (1.6+), contactez-nous. + +## Compilation + +Lancez simplement `make`. + +Vous pouvez aussi utiliser ces options : + +- `make jar`: build the jar file +- `make sjar`: build the source jar file +- `make doc`: préparer la documentation avec Doxygen (`doxygen` est requis) +- `make man`: préparer la man page (`pandoc` est requis) +- `make install PREFIX=/usr/local`: installer le programme (et le manuel si préparé précedemment) dans le PREFIX donné (par défaut, `/usr/local`) +- `make uninstall PREFIX=/usr/local`: désinstaller le programme (et le manuel) du PREFIX donné +- `make clear`: nettoyer les fichiers temporaires +- `make mrpropre`: nettoyer tout, y compris les binaires générés et la documentation +- `make test`: préparer les tests unitaires (la librairie `check` est requise) +- `make run-test`: démarrer les tests unitaires + +### Librairies dépendantes (incluses) + +Nécessaires : + +- [```libs/xxx-sources.jar```](https://xxx): YYY + +Optionnelles : + +- [```libs/xxx-sources.jar```](https://xxx): YYY + +Submodules: + +- ```src/be/nikiroo/utils```: quelques utilitaires partagés depuis [https://github.com/nikiroo/nikiroo-utils.git](https://github.com/nikiroo/nikiroo-utils.git) -- branche ```subtree``` + +Rien d'autre, si ce n'est Java 1.6+. + +À noter : ```make libs``` exporte les librairies de `libs/` dans `src/`. + +## Auteur + +MyProgram a été écrit par Niki Roo + diff --git a/readme/README.c.md b/readme/README.c.md new file mode 100644 index 0000000..e5e595f --- /dev/null +++ b/readme/README.c.md @@ -0,0 +1,40 @@ +English [Français](README-fr.md) + +# MyProgram + +Small description. + +## Synopsis + +- `myprogram --help` + +## Description + +Long description. + +Multiple paragraphs are also ok. + +## Options + +- **--help** (or **-h**): information about the syntax + +## Compilation + +Just run `make`. + +You can also use those make targets: + +- `make doc`: build the Doxygen documentation (`doxygen` required) +- `make man`: build the man page (`pandoc` required) +- `make install PREFIX=/usr/local`: install the program into PREFIX (default is `/usr/local`) and the manual if built +- `make uninstall PREFIX=/usr/local`: uninstall the program from the given PREFIX +- `make clear`: clear the temporary files +- `make mrpropre`: clear everything, including the main executable and the documentation +- `make test`: build the unit tests (`check` required) +- `make run-test`: start the unit tests +- `make run-test-more`: start the extra unit tests (can be long) + +## Author + +MyProgram was written by Niki Roo + diff --git a/readme/README.java.md b/readme/README.java.md new file mode 100644 index 0000000..27bd196 --- /dev/null +++ b/readme/README.java.md @@ -0,0 +1,68 @@ +English [Français](README-fr.md) + +# MyProgram + +Small description. + +## Synopsis + +- `myprogram --help` + +## Description + +Long description. + +Multiple paragraphs are also ok. + +## Options + +- **--help** (or **-h**): information about the syntax + +### Supported platforms + +Any platform with at lest Java 1.6 on it should be ok. + +It has been tested on Linux (xxx), and YYY (yyy), but feel free to inform us if you try it on another system. + +If you have any problems to compile it with a supported Java version (1.6+), please contact us. + +## Compilation + +Just run `make`. + +You can also use those make targets: + +- `make jar`: build the jar file +- `make sjar`: build the source jar file +- `make doc`: build the Doxygen documentation (`doxygen` required) +- `make man`: build the man page (`pandoc` required) +- `make install PREFIX=/usr/local`: install the program into PREFIX (default is `/usr/local`) and the manual if built +- `make uninstall PREFIX=/usr/local`: uninstall the program from the given PREFIX +- `make clear`: clear the temporary files +- `make mrpropre`: clear everything, including the main executable and the documentation +- `make test`: build the unit tests (`check` required) +- `make run-test`: start the unit tests + +### Dependant libraries (included) + +Required: + +- [```libs/xxx-sources.jar```](https://xxx): YYY + +Optional: + +- [```libs/xxx-sources.jar```](https://xxx): YYY + +Submodules: + +- ```src/be/nikiroo/utils```: some shared utility functions from [https://github.com/nikiroo/nikiroo-utils.git](https://github.com/nikiroo/nikiroo-utils.git) -- branch ```subtree``` + +Nothing else but Java 1.6+. + +Note that ```make libs``` will export the libraries from `libs` into `src/`. + + +## Author + +MyProgram was written by Niki Roo + diff --git a/readme/changelog-fr.md b/readme/changelog-fr.md new file mode 100644 index 0000000..ea5b2d5 --- /dev/null +++ b/readme/changelog-fr.md @@ -0,0 +1,9 @@ +# MyProgram + +## Version WIP + +- new: utilisation de submodules git +- new: remplacement du configure.sh par un Makefile +- changed: quelque chose a changé +- fix: correction d'un bug + diff --git a/readme/changelog.md b/readme/changelog.md new file mode 100644 index 0000000..6f6db0f --- /dev/null +++ b/readme/changelog.md @@ -0,0 +1,9 @@ +# MyProgram + +## Version WIP + +- new: use git submodules instead of sub branches +- new: remove configure.sh, use simple Makefile +- changed: something is not the same anymore +- fix: fix/correction of a bug +