FlightControl-Master/MOOSE
1
0
Fork 0
mirror of https://github.com/FlightControl-Master/MOOSE.git synced 2025-10-29 16:58:06 +00:00
Code Issues Packages Projects Releases Wiki Activity

Restructure of the docs content

Browse Source
This commit is contained in:
kaltokri
2023-11-10 15:36:54 +01:00
parent 6d9333aa94
commit b38dc62be7
11 changed files with 70 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

46
docs/developer/buildsystem/build-includes.md Normal file
View File

@@ -0,0 +1,46 @@
---
parent: Build system
grand_parent: Developer
nav_order: 1
---
# Build include files
Main build steps to create the include files are defined in [.github/workflows/build-includes.yml]:
- Checkout of the git repository [MOOSE].
- Create output folders.
- Update the Linux system software.
- Install needed tools:
- [tree] - A tool to output a tree view of a folder structure.
- [lua5.3] - Package to run [Lua] scripts. Version 5.3 is needed, because we
need liblua5.3-dev for [LuaSrcDiet].
- [LuaRocks] - LuaRocks is the package manager for Lua modules.
- liblua5.3-dev - Header file of [Lua] needed for [LuaSrcDiet] to work.
- [LuaSrcDiet] - To compress the [Lua] code and create `Moose_.lua`.
- [LuaCheck] - This is a static code analyzer and a linter for [Lua].
- Run the build steps:
- Run `./Moose Setup/Moose_Create.lua` to create `Moose.lua`.
- Run `./Moose Setup/Moose_Create.lua` to create dynamic `Moose.lua` to
load individual Lua class files used by Moose developers.
- Run [LuaSrcDiet] to compress the [Lua] code and create `Moose_.lua`
- Run [LuaCheck] to find errors in the code. Warnings are ignored, because
there are a lot of warnings, which cannot be resolved by the Moose team.
- Deploy build results:
- Checkout [MOOSE_INCLUDE] git repository in a subdirectory.
- Use the same branch used to checkout [MOOSE] git repository.
- Use a `TOKEN` for checkout, so a `push` is possible later on.
- Copy build result to `MOOSE_INCLUDE` folder
- Push results to [MOOSE_INCLUDE] repository
[.github/workflows/build-includes.yml]: https://github.com/FlightControl-Master/MOOSE/blob/master/.github/workflows/build-includes.yml
[tree]: https://wiki.ubuntuusers.de/tree/
[lua5.3]: https://www.lua.org/manual/5.3/
[LuaRocks]: https://luarocks.org/
[LuaCheck]: https://github.com/mpeterv/luacheck
[MOOSE]: https://github.com/FlightControl-Master/MOOSE
[MOOSE_INCLUDE]: https://github.com/FlightControl-Master/MOOSE_INCLUDE
[LuaSrcDiet]: https://github.com/jirutka/luasrcdiet
[Lua]: https://www.lua.org/