From 91ee13089027fe3ff80a9514238c5c394ffd2e02 Mon Sep 17 00:00:00 2001 From: Reece Wilson Date: Sun, 5 Mar 2023 21:25:59 +0000 Subject: [PATCH] [*] updated readme --- README_Developers.txt | 13 ++++++------- README_Users.txt | 8 -------- 2 files changed, 6 insertions(+), 15 deletions(-) diff --git a/README_Developers.txt b/README_Developers.txt index b1a2840..46262d7 100644 --- a/README_Developers.txt +++ b/README_Developers.txt @@ -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 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. +will likely end up forked alongside a ./Build_UserScripts reference repo away from upstream. # 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 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. +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 @@ -31,12 +30,12 @@ customers. * clang * coreutils * objcopy -* premake5 (unix global) +* premake5 (https://gitea.reece.sx/AuroraPipeline/premake) # Windows requirements -None +* premake5 [x64](https://gitea.reece.sx/attachments/1aac4182-e9c8-4232-83e0-4adb0f84cc7f) # Project Files diff --git a/README_Users.txt b/README_Users.txt index d57950f..e69de29 100644 --- a/README_Users.txt +++ b/README_Users.txt @@ -1,8 +0,0 @@ -Run the _. 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 [_build/_deploy]_. 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 [!!!] \ No newline at end of file