Added new docs

muit · muit · commit a4736a9ed71c · 2022-08-17T23:13:20.000+02:00
diff --git a/config/_default/menus/menus.en.toml b/config/_default/menus/menus.en.toml
@@ -1,8 +1,8 @@
 [[docs]]
-  name = "Prologue"
+  name = "Quick Start"
   weight = 10
-  identifier = "prologue"
-  url = "/docs/prologue/"
+  identifier = "Quick Start"
+  url = "/docs/quick-start/"
 
 [[docs]]
   name = "Help"
@@ -32,20 +32,20 @@
   name = "Get Started"
   weight = 10
   identifier = "get-started"
-  url = "/docs/prologue/introduction/"
+  url = "/docs/quick-start/introduction/"
 
 [[main]]
-  name = "Quick Start"
+  name = "Install"
   weight = 20
-  identifier = "quick-start"
-  url = "/docs/prologue/quick-start/"
+  identifier = "install"
+  url = "/docs/quick-start/install/"
   parent = "get-started"
 
 [[main]]
-  name = "Install"
+  name = "Introduction"
   weight = 30
-  identifier = "install"
-  url = "/docs/prologue/install/"
+  identifier = "introduction"
+  url = "/docs/quick-start/introduction"
   parent = "get-started"
 
 [[main]]
diff --git a/content/docs/development/_index.md b/content/docs/development/_index.md
@@ -0,0 +1,10 @@
+---
+title: "Development"
+description: "Documentation covering the development of Rift"
+lead: ""
+date: 2020-10-06T08:49:15+00:00
+lastmod: 2020-10-06T08:49:15+00:00
+draft: false
+images: []
+weight: 300
+---
diff --git a/content/docs/development/setup.md b/content/docs/development/setup.md
@@ -0,0 +1,50 @@
+---
+title: "Setup"
+description: "Setting up Rift's development environment."
+lead: "Setting up Rift's development environment."
+draft: false
+images: []
+menu:
+  docs:
+    parent: "development"
+weight: 310
+toc: true
+---
+
+## Requirements
+
+- CMake
+
+On Linux:
+- LLVM 14 or higher
+
+## Cloning Rift
+
+First of all, you will need to clone the project from [{{<projectRepo>}}]({{<projectRepo>}}).
+
+There are many ways to do this, but from the terminal you can for example run:
+
+`git clone {{<projectRepo>}}`
+
+### Initialize submodules
+It is essential we also initialize all submodules (Rift's dependencies).
+
+To do so, run the following command on the project's root folder:
+
+`git submodule update --init --recursive`
+
+### Build Rift's LLVM
+
+Rift uses a custom build process for LLVM which comes packed conveniently with the project, but requires manual setup.
+
+This build can be easily triggered running the script `Programs/SetupLLVM.bat` (or `Programs/SetupLLVM.sh` on MacOS/Linux).
+
+Sit and get comfortable, this might take a while.
+
+Optionally, you could use a pre-built LLVM installation instead on MacOS or Linux. Not on Windows however, since its installation of LLVM does not contain certain elements that are required for us to build Rift.
+
+## Configure & Build
+
+Any CMake workflow you might like should work fine if you followed the previous steps.
+
+If you for example were to use commands, you could first run `cmake -S . -B Build` to configure the project, and then `cmake --build Build` to build it.
diff --git a/content/docs/help/_index.md b/content/docs/help/_index.md
@@ -1,10 +1,10 @@
 ---
 title: "Help"
-description: "Help Doks."
+description: "Help about Rift"
 lead: ""
 date: 2020-10-06T08:49:15+00:00
 lastmod: 2020-10-06T08:49:15+00:00
 draft: false
 images: []
-weight: 600
+weight: 200
 ---
diff --git a/content/docs/help/faq.md b/content/docs/help/faq.md
@@ -9,6 +9,6 @@ images: []
 menu:
   docs:
     parent: "help"
-weight: 630
+weight: 230
 toc: true
 ---
diff --git a/content/docs/help/how-to-update.md b/content/docs/help/how-to-update.md
@@ -9,6 +9,6 @@ images: []
 menu:
   docs:
     parent: "help"
-weight: 610
+weight: 210
 toc: true
 ---
diff --git a/content/docs/help/troubleshooting.md b/content/docs/help/troubleshooting.md
@@ -6,9 +6,9 @@ date: 2020-11-12T15:22:20+01:00
 lastmod: 2020-11-12T15:22:20+01:00
 draft: false
 images: []
-menu: 
+menu:
   docs:
     parent: "help"
-weight: 620
+weight: 220
 toc: true
 ---
diff --git a/content/docs/prologue/install.md b/content/docs/prologue/install.md
diff --git a/content/docs/prologue/quick-start.md b/content/docs/prologue/quick-start.md
diff --git a/content/docs/quick-start/_index.md b/content/docs/quick-start/_index.md
@@ -1,6 +1,6 @@
 ---
-title : "Prologue"
-description: "Prologue Doks."
+title : "Quick Start"
+description: ""
 lead: ""
 date: 2020-10-06T08:48:45+00:00
 lastmod: 2020-10-06T08:48:45+00:00
diff --git a/content/docs/quick-start/compiler.md b/content/docs/quick-start/compiler.md
@@ -0,0 +1,25 @@
+---
+title: "Compiler"
+description: "How to use Rift's compiler"
+date: 2020-11-16T13:59:39+01:00
+lastmod: 2020-11-16T13:59:39+01:00
+draft: false
+images: []
+menu:
+  docs:
+    parent: "quick-start"
+weight: 130
+toc: true
+---
+
+## Running the compiler
+
+`Rift.exe` is the compiler of Rift.
+
+Just like in the editor, a parameter **-p** can be passed to specify the project to build.
+
+```bash
+Rift -p {project_path}
+```
+
+The build files and binaries will be put by default into `{project_path}/Build`.
diff --git a/content/docs/quick-start/editor.md b/content/docs/quick-start/editor.md
@@ -0,0 +1,20 @@
+---
+title: "Editor"
+description: "How to use Rift's editor"
+date: 2020-11-16T13:59:39+01:00
+lastmod: 2020-11-16T13:59:39+01:00
+draft: false
+images: []
+menu:
+  docs:
+    parent: "quick-start"
+weight: 120
+toc: true
+---
+
+## Running the Editor
+
+Openning `RiftEditor.exe` will launch the editor.
+
+If a project directory is provided from CLI the editor will open directly to this project:
+`RiftEditor -p {project_path}`
diff --git a/content/docs/quick-start/install.md b/content/docs/quick-start/install.md
@@ -0,0 +1,24 @@
+---
+title: "Install"
+description: "Where and how to install Rift"
+lead: ""
+date: 2020-10-06T08:48:57+00:00
+lastmod: 2020-10-06T08:48:57+00:00
+draft: false
+images: []
+menu:
+  docs:
+    parent: "quick-start"
+weight: 110
+toc: true
+---
+
+## Downloading a Release
+Rift's releases are published at Github.
+
+In order to download them you can head over to the [releases page](https://github.com/PipeRift/rift/releases), pick the latest available and download the appropiate binary for your operating system.
+
+
+## Unpacking
+Once it has been downloaded, unpack the contents of the download on a folder of your choice. Rift is now ready to be used!
+
diff --git a/content/docs/quick-start/introduction.md b/content/docs/quick-start/introduction.md
@@ -8,7 +8,7 @@ draft: false
 images: []
 menu:
   docs:
-    parent: "prologue"
+    parent: "quick-start"
 weight: 100
 toc: true
 ---
diff --git a/layouts/index.redirects b/layouts/index.redirects
@@ -4,10 +4,11 @@
 {{- end }}
 {{- end }}
 
-# /docs/1.0/prologue/   /docs/1.0/prologue/introduction/
-# /docs/1.0/help/       /docs/1.0/help/how-to-update/
-# /docs/1.0/            /docs/1.0/prologue/introduction/
-# /docs/                /docs/1.0/prologue/introduction/
+/docs/quick-start/       /docs/quick-start/introduction/
+# /docs/1.0/quick-start/ /docs/1.0/quick-start/introduction/
+# /docs/1.0/help/         /docs/1.0/help/how-to-update/
+# /docs/1.0/              /docs/1.0/quick-start/introduction/
+# /docs/                  /docs/1.0/quick-start/introduction/
 #
 # /docs/0.1/*           https://v0-1-0--doks-versioning-poc.netlify.app/docs/0.1/:splat  200
 # /docs/0.2/*           https://v0-2-0--doks-versioning-poc.netlify.app/docs/0.2/:splat  200
diff --git a/layouts/shortcodes/projectRepo.html b/layouts/shortcodes/projectRepo.html
@@ -0,0 +1 @@
+{{ .Site.Params.projectRepo }}
