summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJoshua Shreve <j.a.shreve@gmail.com>2021-07-16 21:25:47 -0400
committerJoshua Shreve <j.a.shreve@gmail.com>2021-07-16 21:25:47 -0400
commit5e9f8f436369c88ab0657fcdbe44f03ff3d05403 (patch)
tree5a4efe8b5dbfd3f2abb4213f1813011fd7d0012d /README.md
parentfaa55f32b84466beefd69fd74af484f1070880ab (diff)
Docker notes added to readme and minor conatiner name change. Changes to default config.
Diffstat (limited to 'README.md')
-rw-r--r--README.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/README.md b/README.md
index 53f3f80..24444b1 100644
--- a/README.md
+++ b/README.md
@@ -13,7 +13,21 @@ As part of the effort to create a new engine I converted the code to cadquery/Op
## Added Features
+### Docker Autobuild
+![Docker Support!](./resources/docker_containers.png)
+At the excellent suggestion of [martint17r](https://github.com/joshreve/dactyl-keyboard/issues?q=is%3Apr+author%3Amartint17r)
+I have added docker configurations with an Windows batch file to assist with getting setup.
+If there is sufficient interest I can add a .sh file as well. If you have
+[docker desktop](https://www.docker.com/products/docker-desktop) installed, the batch file will create the
+dactyl-keyboard image and 3 containers: DM-run: runs the dactyl_manuform.py, DM-config: runs generate_configuration.py,
+and DM-shell: just starts an interactive session to manually run from shell (tip: run bash after entering to get the better
+shell environment). All apps bindmount the src and things directory to allow editing in the host and running in the
+container. While not exactly hard drive space efficient, this hopefully this helps those having issue getting
+cadquery running and prevents local Python conflicts. It works well on my computer, but I don't use
+docker often, so please let me know if you find any issues with the approach.
+
### Refactored
+
Your settings are now created by `generate_configuration.py` or by direct modification fo the `run_config.json` file.
This allows you to save `run_config.json` to share your configuration.