mirror of
https://github.com/pinnacle-comp/pinnacle.git
synced 2024-12-26 21:58:10 +01:00
Update README
This commit is contained in:
parent
969acf7049
commit
a5f9d0eff8
1 changed files with 3 additions and 1 deletions
|
@ -12,7 +12,9 @@
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
## API Documentation
|
## API Documentation
|
||||||
There is now *finally* [some form of documentation](https://github.com/Ottatop/pinnacle/wiki/API-Documentation) so you don't have to dig around in the code. It isn't great and automating it seems like a pain, but hey it's something! This may become out of date real quick though, and I'm probably going to need to move to LDoc in the future.
|
~~There is now *finally* [some form of documentation](https://github.com/Ottatop/pinnacle/wiki/API-Documentation) so you don't have to dig around in the code. It isn't great and automating it seems like a pain, but hey it's something! This may become out of date real quick though, and I'm probably going to need to move to LDoc in the future.~~
|
||||||
|
|
||||||
|
Alrighty there's now a preliminary [doc website](https://ottatop.github.io/pinnacle/) generated with LDoc! There are some missing things like the `Keys` and `Layout` tables as well as any function overloads, but you can now click through @see annotations!
|
||||||
|
|
||||||
## Features
|
## Features
|
||||||
- [x] Winit backend
|
- [x] Winit backend
|
||||||
|
|
Loading…
Reference in a new issue