Deployed e092581 with MkDocs version: 1.5.2

index.html

@@ -219,7 +219,9 @@
 
 
 
-              <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
+
+
+              <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" hidden>
                 <div class="md-sidebar__scrollwrap">
                   <div class="md-sidebar__inner">
 
@@ -300,6 +302,33 @@
     Usage
   </a>
 
+    <nav class="md-nav" aria-label="Usage">
+      <ul class="md-nav__list">
+
+          <li class="md-nav__item">
+  <a href="#needed-things" class="md-nav__link">
+    Needed things
+  </a>
+
+</li>
+
+          <li class="md-nav__item">
+  <a href="#go-package" class="md-nav__link">
+    Go package
+  </a>
+
+</li>
+
+          <li class="md-nav__item">
+  <a href="#examples" class="md-nav__link">
+    Examples
+  </a>
+
+</li>
+
+      </ul>
+    </nav>
+
 </li>
 
         <li class="md-nav__item">
@@ -354,6 +383,8 @@
 
 
 
+
+
               <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
                 <div class="md-sidebar__scrollwrap">
                   <div class="md-sidebar__inner">
@@ -381,6 +412,33 @@
     Usage
   </a>
 
+    <nav class="md-nav" aria-label="Usage">
+      <ul class="md-nav__list">
+
+          <li class="md-nav__item">
+  <a href="#needed-things" class="md-nav__link">
+    Needed things
+  </a>
+
+</li>
+
+          <li class="md-nav__item">
+  <a href="#go-package" class="md-nav__link">
+    Go package
+  </a>
+
+</li>
+
+          <li class="md-nav__item">
+  <a href="#examples" class="md-nav__link">
+    Examples
+  </a>
+
+</li>
+
+      </ul>
+    </nav>
+
 </li>
 
         <li class="md-nav__item">
@@ -437,7 +495,7 @@ <h1 align="center">A Go Game Engine build with GLFW and OpenGL.</h1>
 
 <h2 id="table-of-contents">Table of Contents</h2>
 <ul>
-<li><a href="docs/INSTALLATION/">Installation</a></li>
+<li><a href="https://dimkauzh.github.io/vuelto/docs/INSTALLATION/">Installation</a></li>
 <li><a href="#usage">Usage</a></li>
 <li><a href="#contributing">Contributing</a></li>
 <li><a href="#license">License</a></li>
@@ -446,14 +504,24 @@ <h2 id="table-of-contents">Table of Contents</h2>
 <p/>
 
 <h2 id="usage">Usage</h2>
-<p>Currently were not supporting any way of using this project. After a little work on this project, we will add it to pkg.go.dev so you can use it for your own project, for now, you can only clone this repo and use it.</p>
+<h3 id="needed-things">Needed things</h3>
+<p>There are some extra things you will need to use Vuelto, <a href="https://dimkauzh.github.io/vuelto/docs/INSTALLATION/">see them here</a></p>
+<h3 id="go-package">Go package</h3>
+<p>We have a Go package published, so run this command to add it to your go.mod:</p>
+<pre><code class="language-bash">go get github.com/dimkauzh/vuelto
+
+</code></pre>
+<h3 id="examples">Examples</h3>
+<p>All of our examples are inside the examples directory, so take a look there is you want a example.</p>
 <h2 id="contributing">Contributing</h2>
 <p>We are fully open to contributions, but I will check and test your code before merging it into the dev branch. All your code thats accepted will only be merged into the dev branch, and will be later released with the next release.</p>
 <h2 id="license">License</h2>
 <p>Vuelto is licensed under the <a href="LICENSE">GPLv3 Licence</a>.</p>
 <h2 id="about">About</h2>
 <p>Vuelto is a game engine built with GLFW and OpenGL using Go. My goal is to achieve a good and easy to use game engine for everyone. I am currently working on the engine, and I am not planning to releasing Vuelto (its not ready). I am planning to release a website for the engine that contains a documentation for the engine and a roadmap/changelog. I am also planning to release a couple of tutorials on how to use vuelto. I hope you will enjoy using vuelto. Have fun!</p>
 
+
+