From 62e822f532efc837edc0b538654935740598a0c3 Mon Sep 17 00:00:00 2001 From: J Reece Wilson Date: Sat, 23 Apr 2022 20:38:52 +0100 Subject: [PATCH] [*] Update README --- README.md | 27 +++++++++++++++------------ 1 file changed, 15 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index cb026104..4ab8b8d2 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,11 @@ -## IN DEVELOPMENT +## PREALPHA (in-dev, missing polish and APIs are volatile) ## AuroraRuntime -The Aurora Runtime is a low level platform abstraction layer for cross-platform C++ development -targeting embedded and PC systems. Simply fetch a binary package for your toolchain or integrate -the buildscripts into your applications build pipeline to get started. +The Aurora Runtime is a low level platform abstraction layer for modern cross-platform C++ +development targeting powerful embedded and PC systems. Simply fetch a binary package for +your toolchain or integrate the self-contained buildscripts into your applications build +pipeline to get started. ![console](https://gitea.reece.sx/AuroraSupport/AuroraRuntime/raw/branch/master/Media/wxHello.png) ![picture](https://gitea.reece.sx/AuroraSupport/AuroraRuntime/raw/branch/master/Media/Hello%20Aurora.png) @@ -14,7 +15,8 @@ the buildscripts into your applications build pipeline to get started. - Reduced C++ standard template library dependence (^1) - High performance threading and synchronization primitives (os userland sched optimized) -- Async threading primitives with WaitMultipleObjects/RegisterWaitForSingleObject,RunLoop style interfaces (local IPC) +- Async even driven subsystem with high perf sync primitives +- Abstract kernel file/net transaction, IPC, timer, semaphore, et al abstraction in the form of LoopQueues (like, MacOS Run Loops) - Asynchronous and synchronous IO (network, character, file, buffered, process, and io watcher) - Optional event driven async programming paradigm - Consoles; graphical and standard, file archives @@ -23,7 +25,7 @@ the buildscripts into your applications build pipeline to get started. - Crypto ECC/[25519, P-384, P-256], [AES, RSA, X509], [common digests] - Basic cmdline parsing from any module - Exit and fatal save condition callbacks -- IPC [WIP] +- IPC - Network [WIP] - Random; secure and fast - Hardware Info; memory and cpu info (including features, topology, e-core, and cache info) @@ -46,15 +48,16 @@ Examples: [Hello Aurora](https://gitea.reece.sx/AuroraSupport/HelloAurora) \ Doxygen: \ Tests: [Hello Aurora](https://gitea.reece.sx/AuroraSupport/HelloAurora) \ Cmake-stable: \ -Build Pipeline: https://git.reece.sx/AuroraPipeline/Build +Build Pipeline: https://git.reece.sx/AuroraPipeline/Build \ +Discord: [Invite](https://discord.gg/XYjCGWWa4J) ## Performance -Performance should be that of native performance, ideally that of the best implementation on the -platform, and no worse than the STL. Due to heavyweight requirements and spiral model defined -objectives, a handful of portable C libraries have been brought into achieve compression, crypto, -alloc, and str formatting objectives using known good industry standard libraries. Footprint is -expected to be on the heavier side with optimal performance (incl toll for C++ pluses tradeoffs). +Performance of each system should ideally be that of the best implementation on the platform, +and no worse than the STL. Due to heavyweight requirements and spiral model defined objectives, +a handful of portable C libraries have been brought into achieve compression, crypto, alloc, and +str formatting objectives using known good industry standard libraries. Footprint is expected to +be on the heavier side for optimal performance (incl toll for C++ tradeoffs) and flexibility. Runtime as of 2022-02-01 *without the wxWidgets toolkit, with all compression libraries* on Windows LTSC 2019: