Readme

README.md

@@ -0,0 +1,37 @@
+# TheGates browser
+
+Free and open-source 3D internet browser build with Godot Engine <br/>
+It connects game experiences together like world wide web and allows you to easily access them without installing
+
+[Documentation](https://thegates.readthedocs.io) <br/>
+[Other links](https://lnk.bio/thegates)
+
+## Build
+
+#### 1. Build godot fork (branch tg-4.2):
+
+Editor:
+```
+scons -j $(nproc) dev_build=yes the_gates_sandbox=no compiledb=yes use_llvm=yes linker=lld disable_exceptions=no
+```
+
+Sandbox:
+```
+scons -j $(nproc) dev_build=yes target=template_debug the_gates_sandbox=yes compiledb=yes use_llvm=yes linker=lld disable_exceptions=no
+```
+
+#### 2. Create sandbox environment (only linux)
+
+Run bash command `sandbox/kinda-safe-godot/create_sandbox_env.sh` <br/>
+It will create folder **sandbox** with **sandbox_env.zip** file <br/>
+Copy **sandbox** folder to godot/bin (alongside with compiled editor and sandbox executables)
+
+#### 3. Run project
+
+Start compiled godot editor and open project inside **app** folder
+
+## Screenshots
+
+<img src="screenshots\1-home.png" width="500"> <br/> <br/>
+<img src="screenshots\2-search.png" width="500"> <br/> <br/>
+<img src="screenshots\3-in-game-ui.png" width="500"> <br/> <br/>