Skip to content

Commit 4523cdd

Browse files
committed
Update README.md
1 parent cd13178 commit 4523cdd

File tree

1 file changed

+10
-8
lines changed

1 file changed

+10
-8
lines changed

README.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -72,11 +72,12 @@ What it can do
7272
What it enables you to do
7373
-------------------------
7474

75+
* Handle sounds by a [script](.scripts/handle_sounds.sh)
7576
* Make switchable, simpler and safer [commands](models/BetterCommands/README.md)
7677
* Make "isolated" modules
7778
* Expand your modules
7879
* More possibilities to control logic
79-
* Fastly publish your mod on mod portal
80+
* Quickly publish your mod on mod portal
8081
* Use other's modules/code without adaptation
8182
* Easily manage your documentation
8283
* Auto publishing everywhere (almost)
@@ -96,12 +97,12 @@ Stuff used
9697
* Many GitHub Actions to automatically publish to the Factorio mod portal etc
9798
* [EditorConfig](https://editorconfig.org/) - helps maintain consistent coding styles for multiple developers working on the same project across various editors and IDEs
9899
* Factorio's event handler (See Factorio's folder `..\data\core\lualib\event_handler.lua`)
99-
* [git][git] - version control system
100+
* [git] - version control system
100101
* [Visual Studio Code](https://code.visualstudio.com/) - code editor
101102
* [Lua Language Server](https://github.com/sumneko/lua-language-server) ([Setting without VSCode](https://github.com/sumneko/lua-language-server/wiki/Setting-without-VSCode))
102103
* [EmmyLua Annotation][EmmyLua-Annotations]
103104
* Some ZwerOxotnik's code
104-
* Auto documentation: [GitHub actions](.github/workflows/doc.yml) + [Python](https://www.python.org/) + [sphinx][sphinx] + extensions (more details in [predocs/predocs.md](predocs/predocs.md))
105+
* Auto documentation: [GitHub actions](.github/workflows/doc.yml) + [Python](https://www.python.org/) + [sphinx] + extensions (more details in [predocs/predocs.md](predocs/predocs.md))
105106
* [factorio-mod-luacheck][factorio-mod-luacheck] - This GitHub action will run your mod code through luacheck (not full support)
106107
* Auto publishing using many GitHub actions etc (see [.github/workflows/autoPublish.yml](.github/workflows/autoPublish.yml))
107108

@@ -110,6 +111,7 @@ Additional stuff
110111

111112
* [FactorioSumnekoLuaPlugin](https://github.com/JanSharp/FactorioSumnekoLuaPlugin) - a plugin for the [sumneko.lua vscode extension](https://github.com/sumneko/lua-language-server) to help with factorio related syntax and intelisense. (there's no compability with auto documentation)
112113
* [LuaFormatter](https://github.com/Koihik/LuaFormatter) - reformats your Lua source code (supports several editors)
114+
* Try another example with preprocessor in lua: https://github.com/ZwerOxotnik/factorio-candran-example
113115

114116
How to start?
115117
------------
@@ -140,14 +142,14 @@ Next updates
140142
* More simplification, integrations, examples
141143
* More examples of particular cases on all stages
142144
* Support of [SimpleAPI](https://mods.factorio.com/mod/diplomacy/discussion/60c1eb9177457f7dd7943e14) (diplomacy, money, chat, etc)
143-
* Probably, I'll add [factorio-mod-luacheck][factorio-mod-luacheck]
145+
* Probably, I'll add [factorio-mod-luacheck]
144146
* Improve documentation
145147
* Etc
146148

147149
Requirements
148150
------------
149151

150-
Shell [scripts](./.scripts) depends on [git][git], [7z][7z], [jq][jq].
152+
Shell [scripts](./.scripts) depends on [git], [7z], [jq].
151153

152154
Installation on Debian and Ubuntu:
153155

@@ -165,9 +167,9 @@ Optional Dependencies
165167

166168
| Installation Guide | Translations | Discord |
167169
| ------------------ | ------------ | ------- |
168-
| 📖 [Installation Guide](https://wiki.factorio.com/index.php?title=Installing_Mods) | 📚 [Help with translations](https://crowdin.com/project/factorio-mods-localization) | 🦜 [Discord][discord] |
170+
| 📖 [Installation Guide](https://wiki.factorio.com/index.php?title=Installing_Mods) | 📚 [Help with translations](https://crowdin.com/project/factorio-mods-localization) | 🦜 [Discord] |
169171

170-
If you want to download from this source, then use commands below (requires [git][git]).
172+
If you want to download from this source, then use commands below (requires [git]).
171173

172174
```bash
173175
git clone --recurse-submodules -j8 https://github.com/ZwerOxotnik/factorio-example-mod example-mod
@@ -215,7 +217,7 @@ SOFTWARE.
215217

216218
[jq]: https://stedolan.github.io/jq/download/
217219
[7z]: https://www.7-zip.org/download.html
218-
[discord]: https://discord.gg/YyJVUCa
220+
[Discord]: https://discord.gg/YyJVUCa
219221
[GitHub-page]: https://zweroxotnik.github.io/factorio-example-mod/
220222
[git]: https://git-scm.com/downloads
221223
[factorio-mod-luacheck]: https://github.com/Roang-zero1/factorio-mod-luacheck

0 commit comments

Comments
 (0)