Skip to content

Commit b4db744

Browse files
authored
Fix typos in readme.md (#44)
1 parent 9e286a6 commit b4db744

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

readme.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ This crate is an attempt to make scripting a possibility with the current state
1111
## Why Use Scripts?
1212

1313
- Re-load your game logic without re-compiling the entire crate
14-
- If your game logic is encapsulated with scripts it becomes easilly moddable
14+
- If your game logic is encapsulated with scripts it becomes easily moddable
1515
- Allows writing game logic/UI in a smaller language, making development more accessible to non-coders on your team
1616

1717
## Features
@@ -168,7 +168,7 @@ pub fn trigger_on_update_rhai(mut w: PriorityEventWriter<RhaiEvent<MyRhaiArgStru
168168

169169
### Adding scripts
170170

171-
A script consist of:
171+
A script consists of:
172172
- an asset handle to their code file
173173
- a name which is usually their path relative to the assets folder
174174

@@ -287,17 +287,17 @@ fn main() -> std::io::Result<()> {
287287
```
288288
Currently we generate documentation at runtime due to the way `tealr` works but this might change in the future as ideally this would be done statically.
289289

290-
It is probably a wise idea to setup a separate executable whose purpose is to only generate documentation, and run it every time before a release. But keeping this step in your main app will make sure your script environment is always setup correctly.
290+
It is probably a wise idea to set up a separate executable whose only purpose is to generate documentation, and run it every time before a release. But keeping this step in your main app will make sure your script environment is always set up correctly.
291291

292292
#### Lua
293293

294-
Lua documentation is provided by `tealr`, a wrapper around the `mlua` lua api which decorates their standard types. On top of providing documentation generation it's also capable of generating `d.tl` files which can be used to introduce static typing to lua via the `teal` project (you do not need to use teal to generate documentation).
294+
Lua documentation is provided by `tealr`, a wrapper around the `mlua` lua API which decorates their standard types. On top of providing documentation generation, it's also capable of generating `d.tl` files which can be used to introduce static typing to lua via the `teal` project (you do not need to use teal to generate documentation).
295295

296-
This can all be seen at work in the [this example](bevy_mod_scripting/examples/lua/documentation_gen.rs).
296+
This can all be seen at work in [this example](bevy_mod_scripting/examples/lua/documentation_gen.rs).
297297

298298
##### Teal - Lua static typing
299299

300-
Teal is the reccomended way of introducing lua to your bevy game. This functionality is locked behind the `teal` cargo feature however, since it's quite opinionanted when it comes to your asset structure (`script` and `scripts/build`, folders under `assets`), and also requires `lua` + `teal` + `tealr_doc_gen` (`cargo install --git https://github.com/lenscas/tealr_doc_gen --rev 91afd4a528e7f5b746ac3a6b299c422b42c05db6`) to be installed (see https://github.com/teal-language/tl and `tealr`).
300+
Teal is the recommended way of introducing lua to your bevy game. This functionality is locked behind the `teal` cargo feature however, since it's quite opinionanted when it comes to your asset structure (`script` and `scripts/build`, folders under `assets`), and also requires `lua` + `teal` + `tealr_doc_gen` (`cargo install --git https://github.com/lenscas/tealr_doc_gen --rev 91afd4a528e7f5b746ac3a6b299c422b42c05db6`) to be installed (see https://github.com/teal-language/tl and `tealr`).
301301

302302
Once enabled, `.tl` files can be loaded as lua scripts in addition to `.lua` files and compiled on the fly. With full hot-reloading support. When you're ready to release your game, you just need to run `tl build` from the `assets/scripts` directory to compile your teal files. This will generate `.lua` files under `assets/scripts/build`. You can manage loading scripts using the [`bevy_mod_scripting::lua_path`] macro.
303303

@@ -308,7 +308,7 @@ If `teal` is enabled and you've added the `update_documentation` step to your ap
308308
- any scripts with a `.tl` extension will be compiled to lua code and type checked
309309
On optimized release builds none of this happens (no debug_asserts).
310310

311-
The reccomended workflow is to use vscode and the official teal extension with an additional `tlconfig.lua` file at the **root** of your workspace with the
311+
The recommended workflow is to use vscode and the official teal extension with an additional `tlconfig.lua` file at the **root** of your workspace with the
312312
following content:
313313
```lua
314314
return {
@@ -320,7 +320,7 @@ return {
320320

321321
#### Rhai
322322

323-
Rhai currently does not have any utilities existing for generating documentation (for the rust provided API), once something comes out we'll include it.
323+
Rhai currently does not have any existing utilities for generating documentation (for the rust provided API), once something comes out we'll include it.
324324

325325
## Configuration
326326

0 commit comments

Comments
 (0)