mirrors
/
CC-Tweaked
mirror of https://github.com/SquidDev-CC/CC-Tweaked
1
0
Fork 0
Code Issues Releases Wiki Activity

Rewrite our documentation index 

We're going to flesh this out a lot in the future, but this'll have to
do for now.
This commit is contained in:
SquidDev 2020-04-16 18:18:36 +01:00
parent cb8135a0d1
commit f9f94b8304
2 changed files with 9 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
.gitignore vendored
View File

@ -4,6 +4,7 @@
/build
/out
/doc/**/*.html
/doc/index.json
# Runtime directories
/run

18
doc/index.md
View File

@ -1,13 +1,11 @@
# CC: Tweaked
# ![CC: Tweaked](logo.png) [![Download CC: Tweaked on CurseForge](http://cf.way2muchnoise.eu/title/cc-tweaked.svg)](https://minecraft.curseforge.com/projects/cc-tweaked "Download CC: Tweaked on CurseForge")
This is a small website to test documentation generation from Lua source code.
CC: Tweaked is a fork of [ComputerCraft], adding programmable computers, turtles and more to Minecraft.
This is still very much in the proof-of-concept stage. We've rolled own own documentation
generation tool, and there's a couple of missing features. Furthermore, Java-based APIs
(such as Lua builtins, or @{os}) are not documented.
This website contains documentation for all Lua libraries and APIs from the latest version of CC: Tweaked. This
documentation is still in development, so will most likely be incomplete. If you've found something you think is wrong,
or would like to help out [please get in touch on GitHub][gh].
For more information, please check out [the GitHub issue][gh_issue] and [the
documented source][gh_branch].
[gh_issue]: https://github.com/SquidDev-CC/CC-Tweaked/issues/133
[gh_branch]: https://github.com/SquidDev-CC/CC-Tweaked/tree/feature/doc-gen
[bug]: https://github.com/SquidDev-CC/CC-Tweaked/issues/new/choose
[computercraft]: https://github.com/dan200/ComputerCraft "ComputerCraft on GitHub"
[gh]: https://github.com/SquidDev-CC/CC-Tweaked "CC:Tweaked on GitHub"