lune-org/lune
1
1
Fork 0
mirror of https://github.com/lune-org/lune.git synced 2024-12-12 13:00:37 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Reword readme to guide users towards using the luau file extension instead of lua

Browse source
This commit is contained in:
Filip Tibell 2023-01-20 22:08:16 -05:00
parent c90f40cf30
commit 89d0606d06
No known key found for this signature in database
1 changed files with 7 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
README.md
View file

@ -175,16 +175,20 @@ Lune puts developer experience first, and as such provides type definitions and
## 🏃 Running Lune Scripts ## 🏃 Running Lune Scripts
When you've written a script with either a `.lua` or `.luau` extension, you can run it: After you've written a script file, for example `script-name.luau`, you can run it:
```sh ```sh
lune script-name lune script-name
``` ```
This will look for the script `script-name` in a few locations: This will look for the file `script-name.luau` in a few locations:
- The current directory - The current directory
- The folder `lune` in the current directory, if it exists - The folder `lune` in the current directory, if it exists
- The folder `.lune` in the current directory, if it exists - The folder `.lune` in the current directory, if it exists
If you don't want Lune to look in sub-directories you can provide a full file path with the file extension included, instead of only the file name. If you don't want Lune to look in sub-directories you can provide a full file path with the file extension included, instead of only the file name. <br>
---
**_NOTE:_** _Lune also supports files with the `.lua` extension but using the `.luau` extension is highly recommended._