From ce77ab54ac3fc7ac1281f63ad2ecb39012e1578a Mon Sep 17 00:00:00 2001 From: zabidenhtf Date: Thu, 26 Mar 2026 09:36:19 +0000 Subject: [PATCH] merge AUTHORS and README.md and use markdown for INSTALL file. --- AUTHORS | 28 ---------------------------- INSTALL => INSTALL.md | 19 ++++++------------- README.md | 18 ++++++++++++++++++ 3 files changed, 24 insertions(+), 41 deletions(-) delete mode 100644 AUTHORS rename INSTALL => INSTALL.md (89%) diff --git a/AUTHORS b/AUTHORS deleted file mode 100644 index 983db78..0000000 --- a/AUTHORS +++ /dev/null @@ -1,28 +0,0 @@ -Li-Ri Game - -Official site : http://github.com/petitlapin/Li-Ri - -Copyright (c) 2023 -Johnny Jazeix : port to SDL2 + android + cmake - -Copyright (c) 2006 -Dominique Roux-Serret: roux-serret@ifrance.com : design & programming & graphics & website. -Maf464 : site= http://maf464.free.fr : musics - -Thanks to: -Christian H. and Adrian F. for the German correction. -N. Y. for the Japanese corrections. -David R. and David B.M. for the Spanish corrections. -K. TONNELLE "http://ktonnelle.free.fr" for the Breton translation. -V. Búr for the Esperanto translation. -J. JORGE for the Portuguese translation. -V. Búr for the Slovak translation. -T. Gustavsson for the Swedish transltation. -L. Serafinowski for the Polish translation. -R. Claudio, Bao for Italian corrections. -Mike for the russian corrections. -F. Doruk "http://www.fisek.org.tr" for Turkish translation. -S. Etienne for the Hungarian translation. -W. Bas for Dutch translation. -An, Sanggap for the Korean version and translation. -M. Juhasz for the Hungarian corrections. diff --git a/INSTALL b/INSTALL.md similarity index 89% rename from INSTALL rename to INSTALL.md index 021329b..d18f38d 100644 --- a/INSTALL +++ b/INSTALL.md @@ -1,18 +1,15 @@ -Installation Instructions -************************* +# Installation Instructions Li-Ri depends on SDL2 and SDL2_mixer (and their dependencies). -Compilation via conan: -======================= +## Compilation via conan Install conan 2 and run it: `conan install . --output-folder=build --build=missing`. Then, run cmake to generate the build files: `cmake -DCMAKE_TOOLCHAIN_FILE=build/Release/generators/conan_toolchain.cmake -DUSE_CONAN=ON -DCMAKE_BUILD_TYPE=Release -S . -B build`. At last, run cmake to build the executable: `cmake --build build --config Release`. -Compilation via package manager: -================================ +## Compilation via package manager: Use your favorite tools to install the development packages of SDL2 and SDL2_mixer (preferably latest versions). Then run cmake to generate the build files: `cmake -DCMAKE_BUILD_TYPE=Release -S . -B build`. @@ -21,21 +18,17 @@ To specify the folder where to look for the data files, you can set the variable At last, run cmake to build the executable: `cmake --build build --config Release`. -Installation: -============= +## Installation Adding the option `-DCMAKE_INSTALL_PREFIX=install` will add a new target to install the package in the install/ folder inside your build folder: `cmake -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=install -S . -B build`. This will copy the binary to the ${CMAKE_INSTALL_PREFIX}/bin/ and data in ${CMAKE_INSTALL_PREFIX}/share/Li-Ri folder (except on Windows where it will copy everything in ${CMAKE_INSTALL_PREFIX}/bin/). -Packaging: -========== +## Packaging To create a package, use the *package* target from cmake invocation: `cmake --build build --config Release --target package`. * on Linux, it will create a self extractible tgz file. You can execute it and install it. Then, you can run `bin/Li-ri.sh` from this folder to run Li-Ri. * on macOS, it will generate a .dmg (that has not been tested at all so it may not run at all). * on Windows, a NSIS installer (you need to install NSIS on your computer to generate it). - -Releasing: -========== +## Releasing Update NEWS.yaml to add a new version and the changelog. Then, run `./tools/create_release.sh -v 3.1.5` to update all the files necessary for the release. diff --git a/README.md b/README.md index c2b1b5e..63bb43c 100644 --- a/README.md +++ b/README.md @@ -23,6 +23,24 @@ Gameplay ## Building Information on how to compile Li-Ri is available in the INSTALL file. +## Thanks +* Christian H. and Adrian F. for the German correction. +* N. Y. for the Japanese corrections. +* David R. and David B.M. for the Spanish corrections. +* K. TONNELLE "http://ktonnelle.free.fr" for the Breton translation. +* V. Búr for the Esperanto translation. +* J. JORGE for the Portuguese translation. +* V. Búr for the Slovak translation. +* T. Gustavsson for the Swedish transltation. +* L. Serafinowski for the Polish translation. +* R. Claudio, Bao for Italian corrections. +* Mike for the russian corrections. +* F. Doruk "http://www.fisek.org.tr" for Turkish translation. +* S. Etienne for the Hungarian translation. +* W. Bas for Dutch translation. +* An, Sanggap for the Korean version and translation. +* M. Juhasz for the Hungarian corrections. + ------------- Copyright (c) 2023