diff options
author | xengineering <mail2xengineering@protonmail.com> | 2021-05-25 13:41:33 +0200 |
---|---|---|
committer | xengineering <mail2xengineering@protonmail.com> | 2021-05-25 13:41:33 +0200 |
commit | d7e544b9e4e0513512e688760c75105a37bfd0bd (patch) | |
tree | 94f02c20ae8f92e06e953692a5022818d60f487e | |
parent | 4ab710eba1708966f8ae9e637deafa5be060b6d5 (diff) | |
download | stlscope-d7e544b9e4e0513512e688760c75105a37bfd0bd.tar stlscope-d7e544b9e4e0513512e688760c75105a37bfd0bd.tar.zst stlscope-d7e544b9e4e0513512e688760c75105a37bfd0bd.zip |
Update Documentation
-rw-r--r-- | README.md | 24 | ||||
-rw-r--r-- | data/example.png | bin | 0 -> 10424 bytes | |||
-rw-r--r-- | graphics.go | 6 |
3 files changed, 18 insertions, 12 deletions
@@ -1,16 +1,26 @@ +# stlscope -# stlscope - STL Viewer for the Command Line +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. +![Image is missing](data/example.png "stlscope") -## Current State +## Usage -**Very early** development state. It is not usable and the documentation will lag behind. - -## Expected Usage +Please use the help page to view current usage: ``` -$ stlscope -file model.stl +$ stlscope -h ``` +## Development Milestones + +Done (most recent first): +- [x] implement minimal viable product + +To do (most important first): +- [ ] implement Makefile to support building +- [ ] package for Arch Linux +- [ ] implement controls to modify view +- [ ] improve graphics to better display the model + diff --git a/data/example.png b/data/example.png Binary files differnew file mode 100644 index 0000000..2d8a256 --- /dev/null +++ b/data/example.png diff --git a/graphics.go b/graphics.go index 0aacdb7..7107926 100644 --- a/graphics.go +++ b/graphics.go @@ -12,11 +12,7 @@ import ( ) var ( - vertices = []float32{ - 0.0, 0.5, 0.0, - -0.5, -0.5, 0.0, - 0.5, -0.5, 0.0, - } + vertices []float32 ) const ( |