Mise à jour de 'README'

This commit is contained in:
Sylvain PILLOT 2022-02-28 17:36:37 +01:00
parent 8e6e64699d
commit 6c5c26858e
1 changed files with 7 additions and 40 deletions

47
README
View File

@ -1,46 +1,13 @@
KikooDX's gint project template
===============================
This is a base project for gint softwares.
MagicLight v1.0A for Casio Graph 90+E
Before anything
---------------
Open and read CMakeLists.txt.
The current git contains all the sources and stuff needed to compile the game MagicLight.
Building your project
---------------------
For monochrome calculator target:
$ fxsdk build-fx
Sources would need a major cleaning, as it was my very first addin.
For color calculator target:
$ fxsdk build-cg
Compilation is done with "fxsdk build-cg"
Making changes
--------------
After creating new .c files, add those to the SRC list in CMakeLists and
rebuild. Same process for graphical assets in the corresponding ASSETS
in the corresponding ASSETS* list, but you will also need to edit
assets*/fxconv-metada.
More information can be found on the dedicated page on Planete-Casio here: [url]https://www.planet-casio.com/Fr/programmes/programme4210-1-magic-light-10-finally-slyvtt-jeux-reflexion.html[/url]
Before commiting
----------------
Run this command at the base of the git tree:
$ clang-format -i src/**.c include/**.h
It will beautify the source of your project according to the
configuration in the .clang-format file.
Have fun
Nice tricks
-----------
Search for a function declaration.
$ git grep '$sample'
See changes since last commit.
$ git diff <file>
Require entr, recompile whenever a source file change (poor man LSP).
Ctrl-C to end.
$ find src/ include/ -type f | entr -r fxsdk build-cg
License
-------
Copyright (C) 2021 KikooDX <kikoodx@paranoici.org>
This template is under the 0BSD license. See LICENSE for informations.
Sly