Update README.md

Author: RodrigoPAml

README.md

@@ -1,44 +1,47 @@
 # BoxEngine
 
-BoxEngine is an engine to build 2D and 3D general applications, like games, using the scripting language lua.
+BoxEngine is an engine designed to build both 2D and 3D general applications, such as games, using the Lua scripting language. This engine is ideal for creating applications quickly, thanks to its abstract layers implemented with OpenGL, which facilitate fast prototyping.
 
-This engine is ideal to build applications using the abstract layers implemented with OpenGL for fast prototypes
-It uses the GameObject architecture to build the scene with script attached to give it behaviour.
-
-The engine runs in c++ but the scripting language is in LUA (with JIT compiler), a Brazilian language.
-
-Projects can be run in production mode (pass folder via argument) or editor mode
+## Key Features:
+- **GameObject Architecture**: Construct your scene using a GameObject architecture, where scripts are attached to objects to define their behavior.
+- **C++ Core**: The engine is built in C++ for performance, with Lua as the scripting language, featuring a Just-In-Time (JIT) compiler.
+- **Dual Mode Operation**: Projects can be run in two modes:
+  - **Production Mode**: Execute the project by passing the folder as an argument.
+  - **Editor Mode**: Utilize a built-in editor for project development.
 
 # Features
 
 ## Scripting features
 
-* input module (keyboard and mouse)
-* audio module (2d and 3d audios)
-* font module (with support for any .ttf)
-* camera module (support for 2d and 3d camera manipulations)
-* debug/logging module (logging support also in scripting)
-* texture module (allows to manipulate texture with the GPU)
-* shader module (allows to create and use shader with the GPU)
-* vertex module (allows to allocate mesh with the GPU)
-* framebuffer module (manipulate framebuffer via GPU)
-* primitives module (allows to draw basic shapes in 2d and 3d, including to draw textures)
-* scene module (allows to instantiate GO and scripts and manipulate the game scene)
-* import module (allows to import 3d object files, currently have a basic version)
-* renderer module (allows to draw 3d models, currently have a basic version)
-* GUI module (to do)
-* physics module (to do)
+Read the scripting api documentation [here](https://github.com/RodrigoPAml/BoxEngine/blob/main/docs/api.md)
+
+* Input module (keyboard and mouse)
+* Audio module (2d and 3d audios)
+* Font module (with support for any .ttf)
+* Camera module (support for 2d and 3d camera manipulations)
+* Debug/logging module (logging support also in scripting)
+* Texture module (allows to manipulate texture with the GPU)
+* Shader module (allows to create and use shader with the GPU)
+* Vertex module (allows to allocate mesh with the GPU)
+* Framebuffer module (manipulate framebuffer via GPU)
+* Primitives module (allows to draw basic shapes in 2d and 3d, including to draw textures)
+* Scene module (allows to instantiate GO and scripts and manipulate the game scene)
+* Import module (allows to import 3d object files, currently have a basic version)
+* Renderer module (allows to draw 3d models, currently have a basic version)
+* GUI module (to do, basically por ImGui inside framebuffer)
+* Physics module (to do)
 
 ## Editor features
 
-* Open an Create projects
-* Play and Editor mode wich can be detected via script/go to manipulate the scene
-* Manipulate game scene via Game Tree (create go, duplicate, delete)
+* Open and create projects
+* Play and Editor mode which can be detected via script/GO to manipulate the scene
+* Manipulate game scene via Game Tree (create GO, duplicate, delete)
 * Logs tab to help debug the editor and the application
 * Files tab to help manipulate project files (game assets)
 * Info tab to see engine internal information (instance of mesh, textures, fps, frametime)
-* Inspector to allow manipulate a gameobject, add scripts and modify project settings 
-* Integration with vs code for scripting (recommend use lua server extension)
+* Inspector to allow manipulate a game object, add scripts and modify project settings 
+* Integration with VS Code for scripting (recommend using Lua server extension)
+* Script debugging and much more
 
 ## Script example
 
@@ -49,7 +52,7 @@ function teste.start()
     local this = engine.current()
 
     engine.log('starting')
-    engine.log('My go id is' .. engine.go.current())
+    engine.log('My GO id is' .. engine.go.current())
     engine.log('My script name is' .. engine.script.current())
 
     this.var = 'abc'
@@ -78,29 +81,17 @@ end
 * STB_IMAGE https://github.com/nothings/stb/blob/master/stb_image.h (image lib)
 * LUA JIT https://luajit.org/ (jitted scripit language) 
 
-# Screen Shoots
-
-## Playing in editor mode
-
-![image](https://github.com/RodrigoPAml/BoxEngine/assets/41243039/f0d02127-782f-4fb4-9209-b1361e0e2b19)
-
-![image](https://github.com/RodrigoPAml/BoxEngine/assets/41243039/de860063-8b48-4131-ad01-637ad0eb92c2)
-
-# Scripting API Documentation
-
-Read the scripting api documentation [here](https://github.com/RodrigoPAml/BoxEngine/blob/main/docs/api.md)
-
 # Projects
 
-The code is in the Projects folder
+The projects can be found in the projects/external folder, where you have to do a ```git submodule init``` and then a ```git submodule update```
 
-## First game
+## First 2D Game
 
 The first game is called "Air Figther" and game be found in games folder
 
-It's a game about destroying enemies airplane and getting the better possible score
+It's a game about destroying enemies airplane and getting to destroy a final boss
 
-This game was made to validade the engine release
+This game was made to validade the engine release and can find it [here](https://github.com/RodrigoPAml/AirFighter)
 
 ![1](https://github.com/RodrigoPAml/BoxEngine/assets/41243039/13caab37-b00e-419d-be03-69e44108b269)
 
@@ -110,6 +101,8 @@ This game was made to validade the engine release
 
 One implemented fractal and one retrieved from shader toy (link in shader file)
 
+Repository in [here](https://github.com/RodrigoPAml/MandelbrotFractal)
+
 ![image](https://github.com/RodrigoPAml/BoxEngine/assets/41243039/b17b1fe9-c4b1-42d4-8a97-e17d224e339d)
 
 My fractal
@@ -118,7 +111,7 @@ My fractal
 
 ## 3D Scene
 
-Open an 3d object an draw it with renderer
+Open an 3d object an draw it with renderer, this is in the projects/example folder
 
 ![image](https://github.com/RodrigoPAml/BoxEngine/assets/41243039/07b75cc4-aba1-4a98-867f-966723d3260b)
 
@@ -128,7 +121,9 @@ Open an 3d object an draw it with renderer
 
 ## 2D Ray Tracing
 
-The first attemp to implement ray tracing in openGL
+The first attemp to implement ray tracing in OpenGL using BoxEngine
+
+Repository in [here](https://github.com/RodrigoPAml/RayTracer2D)
 
 ![image](https://github.com/RodrigoPAml/BoxEngine/assets/41243039/ca12a844-35c0-4eb0-8313-531769a752e9)