aboutsummaryrefslogtreecommitdiff
path: root/tools/README.md
diff options
context:
space:
mode:
authorJoshua Yun <joshua@joshuayun.com>2025-02-16 23:48:14 -0600
committerJoshua Yun <joshua@joshuayun.com>2025-02-16 23:48:14 -0600
commit39525c80c33d77fad0a4ee6e295602d860de7683 (patch)
tree18149c40521408c4f0c66243d8c1359016007f7b /tools/README.md
parentd04ee56989438c7fbb04bfe614eb11ee095206d8 (diff)
downloadriscv-processor-39525c80c33d77fad0a4ee6e295602d860de7683.tar.gz
documented docker setup
Diffstat (limited to 'tools/README.md')
-rw-r--r--tools/README.md6
1 files changed, 6 insertions, 0 deletions
diff --git a/tools/README.md b/tools/README.md
new file mode 100644
index 0000000..2f86fe2
--- /dev/null
+++ b/tools/README.md
@@ -0,0 +1,6 @@
+# Docker environment setup
+This docker container has everything you need to develop.
+To build the docker image, run docker build -t bingchao:latest . in this directory
+
+Then run ./devbox.sh to enter the work environment.
+The config directory mounts to the .config directory in root, for you to add your vim/nvim/tmux configurations.