Skip to content

Commit e19e3cb

Browse files
committed
Upd8d Readme again
1 parent ea7421d commit e19e3cb

File tree

1 file changed

+35
-10
lines changed

1 file changed

+35
-10
lines changed

README.md

Lines changed: 35 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,36 @@
1-
# Sloth
2-
![](models/demo/pikachu.gif)
1+
# sloth - A one-of-a-kind Rust 3D Renderer for the CLI
2+
![pikachu](models/demo/pikachu.gif)
3+
34
A one-of-a-kind command line 3D software rasterizer made with termion, tobj, and nalgebra. Currently it
4-
supports OBJ file formats without textures or materials. Here's a really simple command for you to get started.
5-
`cargo run --release -- models/hand.obj`
6-
For multiple models:
7-
`cargo run --release -- "models/suzy.obj models/hand.obj"`
8-
You can also generate a static image:
9-
`cargo run --release -- image -w <width_in_pixels> -h <height_in_pixels> models/suzy.obj`
10-
You can also generate a portable Javascript render like this:
11-
`cargo run --release -- image -j <number_of_frames> -w <width_in_pixels> -h <height_in_pixels> models/suzy.obj`
5+
supports OBJ file formats without textures.
6+
7+
[Javascript Export Demonstration](http://ecumene.xyz/sloth-demo)
8+
9+
## Getting Started / Uses
10+
---
11+
Here's a few really simple commands for you to get started.
12+
13+
You can replace `sloth` with `cargo run --release` anywhere
14+
15+
#### Render pikachu
16+
```
17+
sloth models/Pikachu.obj
18+
```
19+
#### For multiple models:
20+
```
21+
sloth "models/suzy.obj models/Pikachu.obj"
22+
```
23+
#### You can also generate a static image:
24+
```
25+
sloth image -w <width_in_pixels> -h <height_in_pixels> models/Pikachu.obj
26+
```
27+
#### You can also generate a portable Javascript render like this:
28+
```
29+
sloth image -j <number_of_frames> -w <width_in_pixels> -h <height_in_pixels> models/Pikachu.obj > src-webify/data.js
30+
```
31+
32+
Thank you, contributors!
33+
---
34+
[Maxgy](https://github.com/Maxgy) – Rustfmt lint
35+
[donbright](https://github.com/donbright) – STL model loading added, Rustfmt lint
36+
[jonathandturner](https://github.com/jonathandturner) – Crossterm port

0 commit comments

Comments
 (0)