AuroraPipeline/Build
1
1
Fork 0
Code Issues 2 Pull Requests Releases Wiki Activity

[*] updated readme

Browse Source
This commit is contained in:
Reece Wilson 2023-03-05 21:25:59 +00:00
parent 4f34946f1d
commit 91ee130890
2 changed files with 6 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README_Developers.txt
View File

@ -4,7 +4,7 @@ The Aurora Ecosystem incorporates this repository as an inheritable starting poi
Extending and retargeting existing robost meta-pipeline software can be a pain, but with premakes relatively simple 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 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, 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. will likely end up forked alongside a ./Build_UserScripts reference repo away from upstream.
# API # API
@ -19,10 +19,9 @@ Entry -> ./Public/base.lua
We decided that, instead of gluing together old nasty pipelines, we would write simple JSON files to quickly add 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 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, requirements. For now, they serve as a simple way to describe a C/C++'s project structure, but in the future they
they serve as a simple way to describe a C/C++'s project structure. Advanced users can write user scripts in native 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, our experimental clang driver will be limited in its support for your lua, using an untouched premake api; however,
customers.
# Linux requirements # Linux requirements
@ -31,12 +30,12 @@ customers.
* clang * clang
* coreutils * coreutils
* objcopy * objcopy
* premake5 (unix global) * premake5 (https://gitea.reece.sx/AuroraPipeline/premake)
# Windows requirements # Windows requirements
None * premake5 [x64](https://gitea.reece.sx/attachments/1aac4182-e9c8-4232-83e0-4adb0f84cc7f)
# Project Files # Project Files

8
README_Users.txt
View File

@ -1,8 +0,0 @@
Run the <yourplatform>_<yourarch>.<ext> script to generate project files optimized for your platform.
You can find the workspace generated by premake under the default path of ../Build_Workspace
For ease of installment, some platforms provide <yourplatform>[_build/_deploy]_<yourarch>.<ext> scripts.
_build -> Compiles Aurora ship binaries to ../Build_Stage
_deploy -> Builds and runs the deploy tasks to push ../Build_Ship to [fill in the blank]
[!!!] CMAKE IS NOT READY [!!!]