From 07c5f545abbcfe9bd1b87e1a17eaec76939594ba Mon Sep 17 00:00:00 2001
From: Tobias Frisch <tfrisch@uni-koblenz.de>
Date: Sun, 3 Jul 2022 17:02:17 +0200
Subject: [PATCH] Add information to setup your IDE
Signed-off-by: Tobias Frisch <tfrisch@uni-koblenz.de>
---
README.md | 5 +++++
doc/SETUP_IDE.md | 29 +++++++++++++++++++++++++++++
resources/extensions.txt | 6 ++++++
scripts/setup-codium.sh | 19 +++++++++++++++++++
4 files changed, 59 insertions(+)
create mode 100644 doc/SETUP_IDE.md
create mode 100644 resources/extensions.txt
create mode 100755 scripts/setup-codium.sh
diff --git a/README.md b/README.md
index 202672d0..05d0754f 100644
--- a/README.md
+++ b/README.md
@@ -44,6 +44,11 @@ The following modules will be provided in this repository and they will automati
- [Shader-Compiler](modules/shader_compiler/README.md)
- [Upscaling](modules/upscaling/README.md)
+## Development
+
+See this guide to setup your IDE for most forward development.
+ - [How to setup your IDE](doc/SETUP_IDE.md)
+
## Documentation
A pre-built documentation can be found here:
diff --git a/doc/SETUP_IDE.md b/doc/SETUP_IDE.md
new file mode 100644
index 00000000..f48deb40
--- /dev/null
+++ b/doc/SETUP_IDE.md
@@ -0,0 +1,29 @@
+# How to setup your IDE
+
+## VSCodium
+
+1. Install [VSCodium](https://github.com/VSCodium/vscodium)
+2. Run `scripts/setup-codium.sh` in your local repository
+3. Run VSCodium and open your local repository as project
+
+### VSCode
+
+If you should prefer to use the official binaries from Microsoft including their own telemetry, you can follow these steps:
+
+1. Download and install [VSCode](https://code.visualstudio.com/Download)
+2. Run `scripts/setup-codium.sh` in your local repository or in case of a Windows host run following line from PowerShell:
+```
+Get-Content resources\extensions.txt | ForEach-Object {code --install-extension $_}
+```
+3. Run VSCode and open your local repository as project
+
+## Eclipse CDT
+
+1. Download and install [Eclipse CDT](https://www.eclipse.org/cdt/downloads.php)
+2. Run Eclipse CDT and open your local repository as project
+
+## CLion
+
+1. Download and install [CLion](https://www.jetbrains.com/clion/download/)
+2. Run CLion and open your local repository as project
+
diff --git a/resources/extensions.txt b/resources/extensions.txt
new file mode 100644
index 00000000..db1c0ef7
--- /dev/null
+++ b/resources/extensions.txt
@@ -0,0 +1,6 @@
+GitLab.gitlab-workflow
+llvm-vs-code-extensions.vscode-clangd
+ms-vscode.cmake-tools
+slevesque.vscode-3dviewer
+twxs.cmake
+webfreak.debug
diff --git a/scripts/setup-codium.sh b/scripts/setup-codium.sh
new file mode 100755
index 00000000..66a217d8
--- /dev/null
+++ b/scripts/setup-codium.sh
@@ -0,0 +1,19 @@
+#!/bin/bash
+
+CODIUM=codium
+
+if [ ! -f /usr/bin/codium ]; then
+ if [ -f /usr/bin/code ]; then
+ CODIUM=code
+ else
+ echo "Please install VSCodium on your system!"
+ echo "More information here: https://github.com/VSCodium/vscodium"
+ exit
+ fi
+fi
+
+cat "resources/extensions.txt" | while read EXTENSION || [[ -n $EXTENSION ]];
+do
+ $CODIUM --install-extension $EXTENSION --force
+done
+
--
GitLab