BlackMATov/evolved.lua
1
0
Fork 0
mirror of https://github.com/BlackMATov/evolved.lua.git synced 2025-12-15 04:15:28 +07:00
Code Issues Packages Projects Releases Wiki Activity

update README

Browse Source
This commit is contained in:
BlackMATov
2025-05-23 22:05:09 +07:00
parent 9c6e53e610
commit e78c4e8d6b
3 changed files with 18 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
.vscode/settings.json vendored
View File

@@ -8,6 +8,7 @@
"markdown.extension.toc.levels": "2..6", "markdown.extension.toc.levels": "2..6",
"markdown.extension.toc.omittedFromToc": { "markdown.extension.toc.omittedFromToc": {
"README.md": [ "README.md": [
"# Changelog",
"# API Reference" "# API Reference"
] ]
} }

11
GUIDES.md Normal file
View File

@@ -0,0 +1,11 @@
# Guidelines
## Checklists
### Adding a New Top-Level Function
1. Insert the new function into the `evolved` table in `evolved.lua`.
2. Create tests for the function in `develop/testing/function_name_tests.lua`.
3. Add the new test to `develop/all.lua`.
4. Document the function in the **Cheat Sheet** and **API Reference** sections of `README.md`.
5. Provide a description in the **Overview** section of `README.md`.
6. Describe the update in the **Changelog** section of `README.md`.

6
README.md
View File

@@ -1123,6 +1123,12 @@ builder_mt:destruction_policy :: id -> builder
`evolved.lua` is licensed under the [MIT License][license]. For more details, see the [LICENSE.md](./LICENSE.md) file in the repository. `evolved.lua` is licensed under the [MIT License][license]. For more details, see the [LICENSE.md](./LICENSE.md) file in the repository.
# Changelog
## v1.0.0
- Initial release
# API Reference # API Reference
## Predefs ## Predefs