diff --git a/README.md b/README.md index 56c1a54..2cc039c 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # FxEngine FxEngine is an librairie overlay based on gint designed to provide more -game-oriented commands, such as a 3D engine, which is actually in +game-oriented commands, such as a 3D engine, which is actually in developement. That library is made for fx9860G calculators. This project is linked the [1v13d](/Milang/1v13d) project. @@ -12,52 +12,47 @@ This project is linked the [1v13d](/Milang/1v13d) project. A GNU/Linux distibution. +The GCC toolchain for sh3eb-elf architecture. (with binutils of course) + The [gint kernel](/Lephenixnoir/gint), made by lephenixnoir. The [fxSDK](/Lephenixnoir/fxsdk), designed for gint usage. -The GCC toolchain for sh3eb-elf architecture. (with binutils of course) +You may need [libprof](/Lephenixnoir/libprof) if you want to enable profiling. ### Install the fxengine lib In a terminal, type the following commands : ```sh +./configure # Use --help option to see possible options + make make install # you may use sudo if the compiler's folder has restricted rights ``` -### Remove lib - -Just type this : -```sh -make clear # you may use sudo if the compiler's folder has restricted rights -``` - -### Upgrade - -I recommend to remove and reinstall, but reinstall may work too. - ## Use All the headers are in the folder -When you create a new project with the fxsdk, you have to change a line in the Makefile : +When you create a new project with the fxsdk, you have to change a line in the project.cfg file : Just replace ```sh -lf-fx := $(LDFLAGS) -Tfx9860g.ld -lgint-fx -lgcc -Wl,-Map=build-fx/map +# Additional linker flags +LDFLAGS = ``` by ```sh -lf-fx := $(LDFLAGS) -Tfx9860g.ld -lfxengine -lgint-fx -lgcc -Wl,-Map=build-fx/map +# Additional linker flags +LDFLAGS = -lfxengine -lgint-fx -lprof ``` It simply adds to linker flags the fxengine lib. ### Example : -If you want to use keyboard event gestion, just do +A locale Doxygen documentation (html) is available in the 'doc' folder, you jest have to open 'index.html' -```c -#include -``` -For questions, you can look at the headers, which can be found as well in in the git folder. -I am wrinting some documentation, and you can ask some questions on planet-casio.com/Fr/ \ No newline at end of file +For specific questions, look at planet-casio.com/Fr/ topics. + +## Bug reports + +Please create an issue on [fxengine](/Milang/fxengine)