[*] Update README

This commit is contained in:
Reece Wilson 2022-04-23 20:38:52 +01:00
parent a66fb2c510
commit 62e822f532

View File

@ -1,10 +1,11 @@
## IN DEVELOPMENT ## PREALPHA (in-dev, missing polish and APIs are volatile)
## AuroraRuntime ## AuroraRuntime
The Aurora Runtime is a low level platform abstraction layer for cross-platform C++ development The Aurora Runtime is a low level platform abstraction layer for modern cross-platform C++
targeting embedded and PC systems. Simply fetch a binary package for your toolchain or integrate development targeting powerful embedded and PC systems. Simply fetch a binary package for
the buildscripts into your applications build pipeline to get started. 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) ![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) ![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) - Reduced C++ standard template library dependence (^1)
- High performance threading and synchronization primitives (os userland sched optimized) - 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) - Asynchronous and synchronous IO (network, character, file, buffered, process, and io watcher)
- Optional event driven async programming paradigm - Optional event driven async programming paradigm
- Consoles; graphical and standard, file archives - 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] - Crypto ECC/[25519, P-384, P-256], [AES, RSA, X509], [common digests]
- Basic cmdline parsing from any module - Basic cmdline parsing from any module
- Exit and fatal save condition callbacks - Exit and fatal save condition callbacks
- IPC [WIP] - IPC
- Network [WIP] - Network [WIP]
- Random; secure and fast - Random; secure and fast
- Hardware Info; memory and cpu info (including features, topology, e-core, and cache info) - 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: \ Doxygen: \
Tests: [Hello Aurora](https://gitea.reece.sx/AuroraSupport/HelloAurora) \ Tests: [Hello Aurora](https://gitea.reece.sx/AuroraSupport/HelloAurora) \
Cmake-stable: \ 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
Performance should be that of native performance, ideally that of the best implementation on the Performance of each system should ideally be that of the best implementation on the platform,
platform, and no worse than the STL. Due to heavyweight requirements and spiral model defined and no worse than the STL. Due to heavyweight requirements and spiral model defined objectives,
objectives, a handful of portable C libraries have been brought into achieve compression, crypto, a handful of portable C libraries have been brought into achieve compression, crypto, alloc, and
alloc, and str formatting objectives using known good industry standard libraries. Footprint is str formatting objectives using known good industry standard libraries. Footprint is expected to
expected to be on the heavier side with optimal performance (incl toll for C++ pluses tradeoffs). 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: Runtime as of 2022-02-01 *without the wxWidgets toolkit, with all compression libraries* on Windows LTSC 2019: