Build/README_Developers.txt
2023-03-05 21:25:59 +00:00

60 lines
1.8 KiB
Plaintext

# Main
The Aurora Ecosystem incorporates this repository as an inheritable starting point for building native applications.
Extending and retargeting existing robost meta-pipeline software can be a pain, but with premakes relatively simple
architecture and lua scripts anyone can hack into, software integration pipelines with specific requirements can be
quickly prototyped with little effort. These scripts are intented to be tweaked for specific use cases, and as such,
will likely end up forked alongside a ./Build_UserScripts reference repo away from upstream.
# API
Defer to the code under Public for information on how to integrate these Aurora scripts into your premake pipeline.
API -> ./Public/api.lua
Settings -> ./Public/settings.lua
Entry -> ./Public/base.lua
# User Scripts
We decided that, instead of gluing together old nasty pipelines, we would write simple JSON files to quickly add
and configure C++ projects for the minimum desired outcome. We started writing JSON files around specific project
requirements. For now, they serve as a simple way to describe a C/C++'s project structure, but in the future they
should be able to describe simple deployment and related actions. Advanced users can write user scripts in native
lua, using an untouched premake api; however,
# Linux requirements
* LLVM STL / libc++stl
* clang
* coreutils
* objcopy
* premake5 (https://gitea.reece.sx/AuroraPipeline/premake)
# Windows requirements
* premake5 [x64](https://gitea.reece.sx/attachments/1aac4182-e9c8-4232-83e0-4adb0f84cc7f)
# Project Files
TODO (reece):
# Package Manager
WIP https://git.reece.sx/AuroraPipeline/Scripts
# Existing Pipeline Integration
Defer to README_Premake.txt / README_CMake.txt
# Location
These build scripts are provided such that you may elect to use a git-submodule pointing to a public git server.