Musa-STL-Cpp/README.md

42 lines
1.0 KiB
Markdown

# Musa C++ Standard Template Library
## Project Overview
- This project uses CMake as a demonstration, but it's not really necessary, since the project is so simple.
- Currently, only Windows is supported for the main application and OS base layer.
- All the container classes should be supported on all platforms.
### [TODOs]
[ ] Replace
[ ] Plans to use a metaprogram to modify code for certain reasons (e.g. generating header files, generating stack traces in debug mode)
[ ] Add Linux Support
[ ] Add Android Support
[ ] Add MacOS Support
[ ] Add iOS Support
[ ] Add UI framework
## Configuration
This project uses CMake to configure and build. Currently only Win32 is supported.
```
cmake -G "Visual Studio 17 2022" -A x64 -S . -B build
```
## Build
To build in debug mode:
```
cmake --build build --config Debug
```
To build in release mode:
```
cmake --build build --config Release
```
# APIs
## Base Layer
## Thread-local Context
- Also explain thread creation.
## OS Platform Layer
## Debug Tooling