andras/sdf-2d
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Improve readme

Browse source
This commit is contained in:
schmelczerandras 2020-11-17 10:33:25 +01:00
parent ca703c0131
commit fe393eb5e5
1 changed files with 8 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

14
README.md
View file

@ -4,13 +4,14 @@ A graphics library to enable the real-time rendering of 2D signed distance field
![screenshot of a bumpy tunnel](media/tunnels-screenshot.png) ![screenshot of a bumpy tunnel](media/tunnels-screenshot.png)
![screenshot of a merging circles](media/circles-screenshot.png) ![screenshot of merging circles](media/circles-screenshot.png)
## Links ## Links
- [View it in action](https://sdf2d.schmelczer.dev) - [View it in action (demos)](https://sdf2d.schmelczer.dev)
- [View it in action (video game)](https://decla.red)
- [Documentation](https://schmelczerandras.github.io/sdf-2d/) - [Documentation](https://schmelczerandras.github.io/sdf-2d/)
- [In depth information](https://github.com/schmelczerandras/sdf-2d/blob/master/media/sdf-2d.pdf) - [In-depth information](https://github.com/schmelczerandras/sdf-2d/blob/master/media/sdf-2d.pdf)
## Features ## Features
@ -28,9 +29,9 @@ A graphics library to enable the real-time rendering of 2D signed distance field
- Context lost is handled with automatic restoration - Context lost is handled with automatic restoration
- Can be used without thinking of the GPU _(although for stunning results it, should be kept in mind)_ - Can be used without thinking of the GPU _(although for stunning results it, should be kept in mind)_
![three screenshots from mobiles](media/mobile-screenshots.png) ![four screenshots from mobiles](media/mobile-screenshots.png)
> Three separate screenshots taken on a mobile device > Four separate screenshots taken on a mobile device
## Install ## Install
@ -63,9 +64,10 @@ main();
For further examples, please visit the following repositories: For further examples, please visit the following repositories:
- [Minimal example using Webpack](https://github.com/schmelczerandras/sdf-2d-minimal-example) - [Minimal example (using Webpack)](https://github.com/schmelczerandras/sdf-2d-minimal-example)
- [More complex example](https://github.com/schmelczerandras/sdf-2d-minimal-example) - [More complex example](https://github.com/schmelczerandras/sdf-2d-minimal-example)
- [Source for the demo page](https://github.com/schmelczerandras/sdf-2d-demo) - [Source for the demo page](https://github.com/schmelczerandras/sdf-2d-demo)
- [Source for decla.red, the multiplayer game](https://github.com/schmelczerandras/decla.red)
## Documentation ## Documentation