Build/README_Developers.txt
J Reece Wilson 431fe2afc5 [*] Linux Fixes
[*] Update readme
[*] Fix single arch sln regression
2022-03-20 08:08:03 +00:00

61 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,
you may decide to fork them and host them alongside your ./Build_UserScripts 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. Overtime, we wish to unify everything, and extend these scripts to testing and deployment. For now,
they serve as a simple way to describe a C/C++'s project structure. Advanced users can write user scripts in native
lua, using an untouched premake api; however, our experimental clang driver will be limited in its support for your
customers.
# Linux requirements
* LLVM STL / libc++stl
* clang
* coreutils
* objcopy
* premake5 (unix global)
# Windows requirements
None
# 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.