From d7e544b9e4e0513512e688760c75105a37bfd0bd Mon Sep 17 00:00:00 2001 From: xengineering Date: Tue, 25 May 2021 13:41:33 +0200 Subject: Update Documentation --- README.md | 24 +++++++++++++++++------- 1 file changed, 17 insertions(+), 7 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index e5542a6..f24070b 100644 --- a/README.md +++ b/README.md @@ -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 + -- cgit v1.2.3-70-g09d2