summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorxengineering <mail2xengineering@protonmail.com>2021-03-21 10:39:36 +0100
committerxengineering <mail2xengineering@protonmail.com>2021-03-21 10:39:36 +0100
commit904fa404b6e38564d1486b3b698ef1cb3d63ba8b (patch)
tree2c9715586f68c11d884e9040cdf0f71174e87a77 /README.md
downloadstlscope-904fa404b6e38564d1486b3b698ef1cb3d63ba8b.tar
stlscope-904fa404b6e38564d1486b3b698ef1cb3d63ba8b.tar.zst
stlscope-904fa404b6e38564d1486b3b698ef1cb3d63ba8b.zip
Initial Commit
Diffstat (limited to 'README.md')
-rw-r--r--README.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..da38359
--- /dev/null
+++ b/README.md
@@ -0,0 +1,16 @@
+
+
+# stlscope - STL Viewer for the Command Line
+
+This little program will allow you to view STL files from your terminal.
+
+## Current State
+
+**Very early** development state. It is not usable and the documentation will lag behind.
+
+## Expected Usage
+
+```
+$ stlscope model.stl
+```
+