From 7c861c8663e93171eef1a34a1256b1e3dce169c0 Mon Sep 17 00:00:00 2001
From: Leo <114857318+leonyi4@users.noreply.github.com>
Date: Sat, 20 Apr 2024 16:24:51 +0700
Subject: [PATCH] added README.md

---
 .devcontainer/README.md         | 15 +++++++++++++++
 .devcontainer/devcontainer.json |  1 +
 2 files changed, 16 insertions(+)
 create mode 100644 .devcontainer/README.md

diff --git a/.devcontainer/README.md b/.devcontainer/README.md
new file mode 100644
index 000000000..8945893df
--- /dev/null
+++ b/.devcontainer/README.md
@@ -0,0 +1,15 @@
+# How to use Dev container
+
+- Install Docker and the 'Devcontainer' extension in VSCode
+
+- Clone the repository and open the folder in VSCode
+
+- Use `Ctrl/Cmd + Shift + P` to open the command palette
+
+- Select 'Dev containers: Rebuild and Reopen in Container' Option
+
+- Wait for the container to finish setting up
+
+- Type this command into the terminal `roslaunch pycram ik_and_description.launch` to start roscore
+
+  - Note: Bullet world needs a display to be connected; the render mode needs to be set to direct when running on GitHub codespaces or on WindowOS; Otherwise, the kernel will crash
diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json
index 7d9e8666f..b5c5b59a6 100644
--- a/.devcontainer/devcontainer.json
+++ b/.devcontainer/devcontainer.json
@@ -1,4 +1,5 @@
 {
+  "name": "PyCRAM vscode devcontainer",
   "image": "pycram/pycram:dev",
   "features": {
     "ghcr.io/devcontainers/features/git:1": {},