CC-Tweaked/doc/index.md

# ![CC: Tweaked](logo.png) [![Download CC: Tweaked on CurseForge](https://cf.way2muchnoise.eu/title/cc-tweaked.svg)](https://minecraft.curseforge.com/projects/cc-tweaked "Download CC: Tweaked on CurseForge")

CC: Tweaked is a fork of [ComputerCraft], adding programmable computers, turtles and more to Minecraft.

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].

[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"
Make the CF link https on tweaked.cc It doesn't play nice on GH, but we need it on our actual website. 2020-04-22 13:48:42 +00:00			`# ![CC: Tweaked](logo.png) [![Download CC: Tweaked on CurseForge](https://cf.way2muchnoise.eu/title/cc-tweaked.svg)](https://minecraft.curseforge.com/projects/cc-tweaked "Download CC: Tweaked on CurseForge")`
An initial stab at documentation generation (#360) This adds documentation comments to many of CC's Lua APIs, and a couple of the Java ones, through the use of stubs. We then export these to HTML using illuaminate [1] and upload them to our documentation site [2]. Uploads currently occur on pushes to master and any release/tag. The site is entirely static - there is no way to switch between versions, etc... but hopefully we can improve this in the future. [1]: github.com/SquidDev/illuaminate/ [2]: https://tweaked.cc/ 2020-04-10 09:27:53 +00:00
Rewrite our documentation index We're going to flesh this out a lot in the future, but this'll have to do for now. 2020-04-16 17:18:36 +00:00			`CC: Tweaked is a fork of [ComputerCraft], adding programmable computers, turtles and more to Minecraft.`
An initial stab at documentation generation (#360) This adds documentation comments to many of CC's Lua APIs, and a couple of the Java ones, through the use of stubs. We then export these to HTML using illuaminate [1] and upload them to our documentation site [2]. Uploads currently occur on pushes to master and any release/tag. The site is entirely static - there is no way to switch between versions, etc... but hopefully we can improve this in the future. [1]: github.com/SquidDev/illuaminate/ [2]: https://tweaked.cc/ 2020-04-10 09:27:53 +00:00
Rewrite our documentation index We're going to flesh this out a lot in the future, but this'll have to do for now. 2020-04-16 17:18:36 +00:00			`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].`
An initial stab at documentation generation (#360) This adds documentation comments to many of CC's Lua APIs, and a couple of the Java ones, through the use of stubs. We then export these to HTML using illuaminate [1] and upload them to our documentation site [2]. Uploads currently occur on pushes to master and any release/tag. The site is entirely static - there is no way to switch between versions, etc... but hopefully we can improve this in the future. [1]: github.com/SquidDev/illuaminate/ [2]: https://tweaked.cc/ 2020-04-10 09:27:53 +00:00
Rewrite our documentation index We're going to flesh this out a lot in the future, but this'll have to do for now. 2020-04-16 17:18:36 +00:00			`[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"`