diff --git a/content/docs/components/functions.mdx b/content/docs/components/functions.mdx index 975cb0b..449deeb 100644 --- a/content/docs/components/functions.mdx +++ b/content/docs/components/functions.mdx @@ -30,6 +30,13 @@ pub i32 get_version() { } ``` +You can also point to a specific point (super or crate, or a custom path): +```mist +pub(crate) i32 get_version() { + return 1; +} +``` + ## Mutable Parameters Parameters follow Rust’s ownership rules but use Mist’s local variable syntax. Use `mut` to allow a function to modify its local binding of a value. diff --git a/content/docs/index.mdx b/content/docs/index.mdx index a3906e4..dc64003 100644 --- a/content/docs/index.mdx +++ b/content/docs/index.mdx @@ -72,26 +72,29 @@ void main() { ### Build and Run -To turn your Mist code into an executable, use the `build` command: +To turn your Mist code into an executable, use the `run` command: ```bash title="Terminal" -mist build -``` - -Once the build is successful, you can run your program using standard Cargo commands: - -```bash title="Terminal" -cargo run +mist run ``` > **Pro Tip:** If you encounter any rust errors, head to the build directory and analyze the output, if you see anything unusual in the output, report the issue at https://github.com/mist-go/mist +Or if you only want to transpile to rust + +```bash title="Terminal" +mist transpile +``` + + --- ## Command Reference -| Command | Description | -| -------------- | ---------------------------------------------------------------- | -| `mist build` | Compiles your `.mist` files into Rust code in the output folder. | -| `mist version` | Displays the current version of the Mist compiler. | -| `mist help` | Stuck? Use this to see all available commands and options. | +| Command | Description | +| ---------------- | ----------------------------------------------- | +| `mist run` | Runs the project in the current directory | +| `mist build` | builds the project in the current directory | +| `mist transpile` | transpiles the project in the current directory | +| `mist version` | prints the compiler version | +| `mist help` | prints this message |