aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJoshua Yun <joshua@joshuayun.com>2025-02-17 00:03:51 -0600
committerJoshua Yun <joshua@joshuayun.com>2025-02-17 00:03:51 -0600
commitbf3cb0b74a73a58c5f710d60030cbd4c824b956a (patch)
treeac8ac14aa3421dcfaaf653ae215b779763a3457e
parenta10f4fe82b50455a2031b8e880a49f2f037688e2 (diff)
downloadriscv-processor-bf3cb0b74a73a58c5f710d60030cbd4c824b956a.tar.gz
fixed readme
-rw-r--r--tools/README.md12
-rwxr-xr-xtools/build.sh1
-rw-r--r--tools/docker-compose.yml2
3 files changed, 10 insertions, 5 deletions
diff --git a/tools/README.md b/tools/README.md
index 414cab9..b382ca9 100644
--- a/tools/README.md
+++ b/tools/README.md
@@ -1,8 +1,12 @@
# 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.
-
+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.
diff --git a/tools/build.sh b/tools/build.sh
new file mode 100755
index 0000000..75a00cd
--- /dev/null
+++ b/tools/build.sh
@@ -0,0 +1 @@
+docker build -t devbox:latest .
diff --git a/tools/docker-compose.yml b/tools/docker-compose.yml
index 1b956b9..e7977d9 100644
--- a/tools/docker-compose.yml
+++ b/tools/docker-compose.yml
@@ -1,7 +1,7 @@
services:
dev_environment:
container_name: devbox
- image: bingchao:latest
+ image: devbox:latest
# Allow for interactive terminal
stdin_open: true