Miroirs/pinnacle
1
0
Fork 0
mirror of https://github.com/pinnacle-comp/pinnacle.git synced 2024-11-16 07:48:11 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update README

Browse source
This commit is contained in:
Ottatop 2023-07-23 15:55:23 -05:00
parent d9f503b291
commit 83ef845083
1 changed files with 2 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
README.md
View file

@ -12,9 +12,9 @@
</div>
## 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 a preliminary [doc website](https://ottatop.github.io/pinnacle/main) generated with LDoc. Do note that there are some missing things like the `Keys` table and `Layout` enum as well as any function overloads, but these should be autocompleted through the language server.
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!
Documentation for other branches can be reached at `https://ottatop.github.io/pinnacle/<branch name>`.
## Features
- [x] Winit backend