-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
749ca82
commit 67ef632
Showing
2 changed files
with
46 additions
and
7 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,46 @@ | ||
--- | ||
title: Getting Started | ||
layout: default | ||
nav_order: 2 | ||
--- | ||
|
||
# Getting Started | ||
|
||
## Installation | ||
|
||
### Windows | ||
If you are on Windows64x, you are in luck, we provide precompiled executable for that. | ||
btw, if you use Windows32x for some reason, let me know to create 32x executables for you in the [issues tab on github] | ||
|
||
### Other | ||
As for the moment, we provide no precompiled executable for any other platform | ||
but we plan on providing a precompiled linux executable. | ||
|
||
You will have to build the precompiled executable for your platform. | ||
see [Build From Source] | ||
|
||
### Building From Source | ||
#### Requirements | ||
- A C++17+ Compiler Installed ( I Use MinGW32 ) | ||
- [raylib] Installed | ||
- [wren] Installed | ||
|
||
I see about compiler but having to install libraries seems a bit trouble so we will try to remove that need sooner or later. | ||
|
||
#### Steps | ||
Once you have the requirements completed just run the following code. | ||
```sh | ||
git clone https://github.com/mastercuber55/Cube2D-Engine | ||
cd Cube2D-Engine | ||
git submodule init | ||
git submodule update | ||
mingw32-make // or however you do it for your Makefile | ||
``` | ||
|
||
#### Done | ||
|
||
Thats it, you should now have Cube2D.exe in that folder. | ||
but you gotta learn how to use it of course. | ||
|
||
[issues tab on github]: https://github.com/mastercuber55/Cube2D-Engine/Issues | ||
[Build From Source]: https://just-the-docs.com/docs/navigation-structure/#Build-From-Source |