aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorFranklin Wei <franklin@rockbox.org>2019-11-28 01:47:32 -0500
committerFranklin Wei <franklin@rockbox.org>2019-11-28 01:47:32 -0500
commit00c74d112d31f54cd72e07d2254dc93f4912b32f (patch)
treee96b01e41fb6e42d7751e7a548fbd69fa1009817 /README.md
downloadrastercarve-00c74d112d31f54cd72e07d2254dc93f4912b32f.zip
rastercarve-00c74d112d31f54cd72e07d2254dc93f4912b32f.tar.gz
rastercarve-00c74d112d31f54cd72e07d2254dc93f4912b32f.tar.bz2
rastercarve-00c74d112d31f54cd72e07d2254dc93f4912b32f.tar.xz
Import sources.
Diffstat (limited to 'README.md')
-rw-r--r--README.md11
1 files changed, 11 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..501e561
--- /dev/null
+++ b/README.md
@@ -0,0 +1,11 @@
+# RasterCarve: Generate G-code to engrave raster images
+
+This is a little Python script I wrote to generate 3-axis toolpaths to
+engrave raster images.
+
+## Getting Started
+
+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.