aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorFranklin Wei <franklin@rockbox.org>2019-12-25 22:14:11 -0500
committerFranklin Wei <franklin@rockbox.org>2019-12-25 22:14:11 -0500
commitee860b8ad99670b2c6ac4a059b8dad12fd61b1d2 (patch)
tree36a726536401bdea706efe4759363301ffd9fb34 /README.md
parent5cc5807b25d0c5d0819a2b16500fa54f10f160a4 (diff)
downloadrastercarve-ee860b8ad99670b2c6ac4a059b8dad12fd61b1d2.zip
rastercarve-ee860b8ad99670b2c6ac4a059b8dad12fd61b1d2.tar.gz
rastercarve-ee860b8ad99670b2c6ac4a059b8dad12fd61b1d2.tar.bz2
rastercarve-ee860b8ad99670b2c6ac4a059b8dad12fd61b1d2.tar.xz
Package for PyPI.
Diffstat (limited to 'README.md')
-rw-r--r--README.md8
1 files changed, 2 insertions, 6 deletions
diff --git a/README.md b/README.md
index 6ea8461..21ad837 100644
--- a/README.md
+++ b/README.md
@@ -3,16 +3,12 @@
This is a little Python script I wrote to generate 3-axis toolpaths to
engrave raster images.
-## Dependencies
+## Installation
-You just need Python 3, OpenCV, tqdm, and NumPy (i.e. `pip install
-...`).
+`pip install rastercarve`
## Usage
-The program should be self-documenting. Run `src/rastercarve.py
---help` or see the output below.
-
```
usage: rastercarve.py [-h] (--width WIDTH | --height HEIGHT) [-f FEED_RATE]
[-p PLUNGE_RATE] [--rapid RAPID_RATE] [-z SAFE_Z]