gint-project-template/README

47 lines
1.2 KiB
Plaintext

KikooDX's gint project template
===============================
This is a base project for gint softwares.
Before anything
---------------
Open and read CMakeLists.txt.
Building your project
---------------------
For monochrome calculator target:
$ fxsdk build-fx
For color calculator target:
$ 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.
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.
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.