Skip to content

Commit 4664610

Browse files
authored
Updated README for 1.5 (#560)
1 parent 5beb460 commit 4664610

File tree

1 file changed

+23
-11
lines changed

1 file changed

+23
-11
lines changed

README.md

Lines changed: 23 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
![Overload Logo](https://user-images.githubusercontent.com/33324216/94352497-cc8c2200-0033-11eb-93e1-1a30386133b9.png)
1+
![overload-banner-2](https://github.com/user-attachments/assets/feef5188-582c-4812-bb80-b893026811ee)
22

33
<p align="center">
44
<a href="https://github.com/Overload-Technologies/Overload/releases">Releases</a> |
@@ -51,6 +51,19 @@ Overload pillars are:
5151

5252
Check out our [issues](https://github.com/Overload-Technologies/Overload/issues) and [pull requests](https://github.com/Overload-Technologies/Overload/pulls) to learn more about what's coming next!
5353

54+
# Quick Start (TL;DR)
55+
*Assuming you are on Windows, have Visual Studio 2022 installed, and have about 5 minutes to spare!*
56+
1. Clone Overload
57+
2. Inside of the repository folder, run `OpenInVisualStudio.bat`
58+
3. Build the project, voilà!
59+
60+
- **⭐ Bonus:** get one of Overload's [sample projects](https://github.com/Overload-Technologies/Overload/wiki/Sample-Projects)!
61+
- **✨ Extra Bonus:** check-out the [documentation](https://github.com/Overload-Technologies/Overload/wiki).
62+
63+
More in-depth guide on getting started available [here](#getting-started).
64+
65+
In a rush? [Get the latest release](https://github.com/Overload-Technologies/Overload/releases)!
66+
5467
# Architecture
5568
Overload is divided into 11 modules: 9 libraries (SDK), and 2 executables (Applications).
5669

@@ -72,11 +85,11 @@ Overload applications use the Overload SDK to operate.
7285
- `OvGame`: A data-driven executable for any game built with Overload.
7386
- `OvEditor`: An editor for building your game.
7487

75-
![Editor](https://user-images.githubusercontent.com/33324216/94352908-fd228a80-0038-11eb-849a-c076bde4c7c6.PNG)
88+
![image](https://github.com/user-attachments/assets/3e59ee31-f124-453e-a7e6-2afd79be0e0d)
7689

7790
## Dependencies
7891
Overload depends on a few third-party libraries:
79-
- OpenGL with [GLAD](https://github.com/Dav1dde/glad) (Graphics API)
92+
- [GLAD](https://github.com/Dav1dde/glad) (OpengGL Graphics API)
8093
- [GLFW](https://github.com/glfw/glfw) (Windowing and inputs)
8194
- [Assimp](https://github.com/assimp/assimp) (3D model loader)
8295
- [Bullet3](https://github.com/bulletphysics/bullet3) (Physics)
@@ -145,11 +158,10 @@ If you'd like to contribute, please refer to our [contribution guildelines](http
145158
| **CPU** | x64 |
146159

147160
# Screenshots
148-
![PBR Shading](https://user-images.githubusercontent.com/33324216/94352806-96e93800-0037-11eb-8d7f-9c9a318ca2c7.PNG)
149-
![Material Editor](https://user-images.githubusercontent.com/33324216/94352805-96e93800-0037-11eb-883b-fdd8818b93a6.PNG)
150-
![Standard Shader Library](https://user-images.githubusercontent.com/33324216/94352810-9781ce80-0037-11eb-8788-095794711b2c.PNG)
151-
![Custom Shaders](https://user-images.githubusercontent.com/33324216/94352802-9650a180-0037-11eb-8931-c6b2163c0ef1.PNG)
152-
![Realtime Lighting](https://user-images.githubusercontent.com/33324216/94352808-9781ce80-0037-11eb-8b91-3ec0ab06db45.PNG)
153-
![Scene Edition](https://user-images.githubusercontent.com/33324216/94352809-9781ce80-0037-11eb-9adf-d216eb4d963e.PNG)
154-
![Build System](https://user-images.githubusercontent.com/33324216/94352926-5db1c780-0039-11eb-88ef-7ca14a8bc821.PNG)
155-
![Project Hub](https://user-images.githubusercontent.com/33324216/94352807-9781ce80-0037-11eb-911b-7e3d0d00ce41.png)
161+
![editor](https://github.com/user-attachments/assets/2134f35f-a7f8-4bd6-8f4f-7d4761206cbf)
162+
![custom-shaders](https://github.com/user-attachments/assets/8cfed591-a565-45d2-aa4c-8e3926bdeea6)
163+
![shading](https://github.com/user-attachments/assets/e5219043-eb7f-4859-8345-a61fef9abf93)
164+
![materials](https://github.com/user-attachments/assets/c16f1bfc-7d6a-4610-a5fe-062761513ad6)
165+
![intel-sponza](https://github.com/user-attachments/assets/325fb0b5-54fc-4110-9011-5a51edcebf72)
166+
![intel-sponza-2](https://github.com/user-attachments/assets/87acd196-09aa-4399-af71-f7ac6d1ee34f)
167+
![intel-sponza-3](https://github.com/user-attachments/assets/28a8c112-d723-4e02-b790-a0b023dbc5c6)

0 commit comments

Comments
 (0)