add readme

2026-06-30 16:40:05 +08:00 · 2023-01-03 15:52:48 +00:00
parent e176a5292c
commit 204b9030c9
1 changed files with 17 additions and 1 deletions
@@ -1,3 +1,19 @@
 # devcontainer

-todo
+## example usage
+
+Below are some example use cases you might want to run from within the devcontainer (either within VSCode or GitHub Codespaces).
+
+### Run pre-commit
+
+```bash
+# run pre-commit
+pre-commit run --all-files
+```
+
+### Docker compose
+
+```bash
+# build the image
+docker compose up --build
+```