summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorxengineering <me@xengineering.eu>2022-03-16 19:46:46 +0100
committerxengineering <me@xengineering.eu>2022-03-16 19:46:46 +0100
commitb38538bfd5a3ad3d55473a5c3970f0a46bc63970 (patch)
treec489a8a94c8b8533662bb944d1abfcd7b488fd16
parentc53d6d94e4ee8ca01d857ed5f86899be048ef7f4 (diff)
downloadstlscope-b38538bfd5a3ad3d55473a5c3970f0a46bc63970.tar
stlscope-b38538bfd5a3ad3d55473a5c3970f0a46bc63970.tar.zst
stlscope-b38538bfd5a3ad3d55473a5c3970f0a46bc63970.zip
Reduce text width in README
-rw-r--r--README.md11
1 files changed, 9 insertions, 2 deletions
diff --git a/README.md b/README.md
index d64b4c3..476655c 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,13 @@
# stlscope
-This little program will allow you to view STL files from your terminal. It uses [Go](https://golang.org/) as the programming language, [OpenGL](https://www.opengl.org/) to render the graphics and [GLFW](https://www.glfw.org/) to create a window to display the model. To use OpenGL and GLFW with the Go language a lot of code is used from the [go-gl project](https://github.com/go-gl/). At the moment it is only usable via the command line interface.
+This little program will allow you to view STL files from your terminal. It
+uses [Go](https://golang.org/) as the programming language,
+[OpenGL](https://www.opengl.org/) to render the graphics and
+[GLFW](https://www.glfw.org/) to create a window to display the model. To use
+OpenGL and GLFW with the Go language a lot of code is used from the [go-gl
+project](https://github.com/go-gl/). At the moment it is only usable via the
+command line interface.
![Image is missing](data/example.png "stlscope")
@@ -18,7 +24,8 @@ Have a look at `stlscope -h` to learn about further options.
## Development Milestones
Done (most recent first):
-- [x] improve graphics to better display the model (ambient and diffuse lighting)
+- [x] improve graphics to better display the model (ambient and diffuse
+ lighting)
- [x] package for Arch Linux (get a PKGBUILD file from [here](https://src.xengineering.eu/xengineering/pkgbuilds/src/branch/master/stlscope))
- [x] implement Makefile to support building
- [x] implement minimal viable product