summaryrefslogtreecommitdiff
path: root/README.md
blob: c6456e67819cae59e596567d535e24200f68fe23 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26

# 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.

![Image is missing](data/example.png "stlscope")

## Usage

Please use the help page to view current usage:

```
$ stlscope -h
```

## Development Milestones

Done (most recent first):
- [x] implement Makefile to support building
- [x] implement minimal viable product

To do (most important first):
- [ ] package for Arch Linux
- [ ] implement controls to modify view
- [ ] improve graphics to better display the model