aboutsummaryrefslogtreecommitdiff
path: root/docker_tools/README.md
diff options
context:
space:
mode:
authorLarry Du <ldu0894@gmail.com>2025-02-17 06:42:46 +0000
committerLarry Du <ldu0894@gmail.com>2025-02-17 06:42:46 +0000
commitbed08974f66c5949d8bf07da563dcf426f47c395 (patch)
tree859453def5810b204b3ac0c2fc8cdc2c33cf31b4 /docker_tools/README.md
parent8a4942ca96bc32c3f273a26ceda536adadac0615 (diff)
downloadriscv-processor-bed08974f66c5949d8bf07da563dcf426f47c395.tar.gz
refactor: Renamed 'tools' to 'docker_tools'
Diffstat (limited to 'docker_tools/README.md')
-rw-r--r--docker_tools/README.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/docker_tools/README.md b/docker_tools/README.md
new file mode 100644
index 0000000..630e576
--- /dev/null
+++ b/docker_tools/README.md
@@ -0,0 +1,12 @@
+# Docker environment setup
+This docker container has everything you need to develop.
+
+To build the docker image, run
+```
+./build.sh
+```
+To enter the work environment.
+```
+./devbox.sh
+```
+The config directory mounts to the .config directory in root, for you to add your vim/nvim/tmux configurations.