Update README.md
This commit is contained in:
parent
4f0a350831
commit
767a3c21f1
1 changed files with 14 additions and 7 deletions
21
README.md
21
README.md
|
@ -7,21 +7,28 @@ A Cross-Platform, Cross-GraphicsAPI Game Engine
|
||||||
|
|
||||||
Will support:
|
Will support:
|
||||||
* Vulkan (under development)
|
* Vulkan (under development)
|
||||||
* Metal
|
* Metal (maybe not...)
|
||||||
|
|
||||||
## Supported Operating Systems
|
## Supported Operating Systems
|
||||||
* Windows
|
* Windows
|
||||||
* Linux
|
* Linux (Won't compile ATM)
|
||||||
|
|
||||||
Will support:
|
Will support:
|
||||||
* Mac
|
* Mac
|
||||||
|
|
||||||
## Getting Started
|
## Getting Started
|
||||||
1. `git clone --recurse-submodules -j4 https://github.com/Light3039/Light <folder_name>`
|
|
||||||
* (If you cloned non-recursively run `git submodule update --init`)
|
### Prerequisites
|
||||||
2. `cd <folder_name>/CMake`
|
* OpenGL 4.5 or higher
|
||||||
3. `cmake ..`
|
* DirectX 11 support on Windows machines
|
||||||
4. Build and run the Mirror project
|
|
||||||
|
### Getting the project
|
||||||
|
```bash
|
||||||
|
git clone --recurse-submodules -j4 https://github.com/Light3039/Light <folder_name>
|
||||||
|
# if you cloned non-recursively then run "git submodule update --init"
|
||||||
|
cd <folder_name>/CMake
|
||||||
|
cmake ..
|
||||||
|
```
|
||||||
|
|
||||||
## Acknowledgments
|
## Acknowledgments
|
||||||
Huge thanks to these people:
|
Huge thanks to these people:
|
||||||
|
|
Loading…
Add table
Reference in a new issue