CC-Tweaked/.editorconfig

root = true

[*]
indent_style = space
indent_size = 4
end_of_line = lf
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = true

[*.md]
trim_trailing_whitespace = false

[*.sexp]
indent_size = 2

[*.yml]
indent_size = 2
Update README to explain what this project is Also add a .editorconfig file to ensure some level of consistent formatting. 2017-11-14 22:40:33 +00:00			`root = true`

			`[*]`
			`indent_style = space`
			`indent_size = 4`
			`end_of_line = lf`
			`charset = utf-8`
A wee bit of a cleanup of the API - Move some method over to defaulted methods - Use Objects rather than Preconditions 2018-12-17 21:33:49 +00:00			`trim_trailing_whitespace = true`
Update README to explain what this project is Also add a .editorconfig file to ensure some level of consistent formatting. 2017-11-14 22:40:33 +00:00			`insert_final_newline = true`

			`[*.md]`
			`trim_trailing_whitespace = false`

Lint bios and the rom (#321) We now use illuaminate[1]'s linting facilities to check the rom and bios.lua for a couple of common bugs and other problems. Right now this doesn't detect any especially important bugs, though it has caught lots of small things (unused variables, some noisy code). In the future, the linter will grow in scope and features, which should allow us to be stricter and catch most issues. As a fun aside, we started off with ~150 bugs, and illuaminate was able to fix all but 30 of them, which is pretty neat. [1]: https://github.com/SquidDev/illuaminate 2019-12-03 23:26:13 +00:00			`[*.sexp]`
			`indent_size = 2`

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 10:27:53 +01:00			`[*.yml]`
			`indent_size = 2`