Reviewed-on: #3 Co-authored-by: Musa <musasmahmood@gmail.com> Co-committed-by: Musa <musasmahmood@gmail.com>
49 lines
792 B
Markdown
49 lines
792 B
Markdown
# Build Overview
|
|
|
|
- #TODO: Explain build configuration: library, exe
|
|
- Why do we use CMake (even though I hate it)? (because it's industry standard?)
|
|
- Plans to use a metaprogram to modify code for certain reasons (e.g. getting stack traces)
|
|
|
|
## Configuration
|
|
This project uses CMake to configure and build. Currently only Win32 is supported.
|
|
```
|
|
cmake -S . -B build
|
|
```
|
|
## Build
|
|
To build in debug mode:
|
|
```
|
|
cmake --build build --config Debug
|
|
```
|
|
To build in release mode:
|
|
```
|
|
cmake --build build --config Release
|
|
```
|
|
|
|
## Roadmap for Supporting Other platforms
|
|
|
|
- Linux
|
|
- MacOS
|
|
- Android
|
|
- iOS
|
|
|
|
# APIs
|
|
|
|
## Base Layer
|
|
|
|
### Thread-local Context
|
|
|
|
## OS Platform Layer
|
|
|
|
## Debug Tooling
|
|
|
|
|
|
|
|
# Explorer Application Notes
|
|
|
|
## File Enumeration
|
|
|
|
## Sorting
|
|
|
|
## Searching Algorithms
|
|
|
|
## Multithreading |