aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorFranklin Wei <franklin@rockbox.org>2019-11-28 23:18:39 -0500
committerFranklin Wei <franklin@rockbox.org>2019-11-28 23:18:39 -0500
commit0ba7a03ab2b4a2ae56d9c1a5501ebe2c713b5145 (patch)
tree12d67726d822ec87b047502ca96ab5d253ea643a /README.md
parentc2de4a3258c3e37d4b49a41d786eef936262f137 (diff)
downloadrastercarve-0ba7a03ab2b4a2ae56d9c1a5501ebe2c713b5145.zip
rastercarve-0ba7a03ab2b4a2ae56d9c1a5501ebe2c713b5145.tar.gz
rastercarve-0ba7a03ab2b4a2ae56d9c1a5501ebe2c713b5145.tar.bz2
rastercarve-0ba7a03ab2b4a2ae56d9c1a5501ebe2c713b5145.tar.xz
Docs
Diffstat (limited to 'README.md')
-rw-r--r--README.md7
1 files changed, 6 insertions, 1 deletions
diff --git a/README.md b/README.md
index 501e561..7d6647c 100644
--- a/README.md
+++ b/README.md
@@ -8,4 +8,9 @@ engrave raster images.
You just need Python 3, OpenCV, and NumPy (i.e. `pip install ...`).
Then, just run `python src/rastercarve.py IMAGE`, where `IMAGE` is a
-bitmap image in any format supported by OpenCV.
+bitmap image in any format supported by OpenCV. G-code is output to
+standard output.
+
+## Configuration
+
+Edit `rastercarve.py` to change the material and engraving settings.