diff --git a/src/SUMMARY.md b/src/SUMMARY.md index bf92a09..b8a825f 100644 --- a/src/SUMMARY.md +++ b/src/SUMMARY.md @@ -13,10 +13,10 @@ - [Getting Started](./getting-started/README.md) - [Installation](./getting-started/installation.md) - [Basic Usage](./getting-started/basic-usage.md) + - [Sharing and using your package](./getting-started/sharing-package.md) - [Patching dependencies]() - [Using the Compiler](./using-compiler/README.md) - [Project structure](./using-compiler/project-structure.md) - - [Sharing and using your package](./using-compiler/sharing-package.md) - [Command-Line Interface](./using-compiler/command-line-interface.md) # Nix diff --git a/src/getting-started/basic-usage.md b/src/getting-started/basic-usage.md index 084fb23..46ff30d 100644 --- a/src/getting-started/basic-usage.md +++ b/src/getting-started/basic-usage.md @@ -21,4 +21,4 @@ After [installing the Glistix compiler,](./installation.md) here's how you can s Nice! Your project is now **ready to be used** by both Nix users (which will use your Gleam code compiled to Nix) and also other Glistix users. -To **import a Gleam module in your project from within Nix,** the `default.nix` and `flake.nix` files in your new project export a `lib.loadGlistixPackage { module = "module/name"; }` function, which, when used, will give you an attribute set with all names exported by that module, so you can use its record constructors, constants and functions from within Nix. See [Sharing and using your package](../using-compiler/sharing-package.md) for more information. +To **import a Gleam module in your project from within Nix,** the `default.nix` and `flake.nix` files in your new project export a `lib.loadGlistixPackage { module = "module/name"; }` function, which, when used, will give you an attribute set with all names exported by that module, so you can use its record constructors, constants and functions from within Nix. See [Sharing and using your package](./sharing-package.md) for more information. diff --git a/src/using-compiler/sharing-package.md b/src/getting-started/sharing-package.md similarity index 100% rename from src/using-compiler/sharing-package.md rename to src/getting-started/sharing-package.md diff --git a/src/using-compiler/command-line-interface.md b/src/using-compiler/command-line-interface.md index dbf0cc1..50780f1 100644 --- a/src/using-compiler/command-line-interface.md +++ b/src/using-compiler/command-line-interface.md @@ -5,7 +5,7 @@ Here are some of the most common compiler commands. 1. `glistix new`: An essential command, creates a new Glistix project for you with batteries included, containing: - Several basic directories and files of the project structure expected by the compiler; - This includes an initial `gleam.toml` tuned for Glistix-specific defaults; - - An initial `flake.nix` (see ["Sharing and using your package"](./sharing-package.md)); + - An initial `flake.nix` (see ["Sharing and using your package"](../getting-started/sharing-package.md)); - GitHub Actions workflows for CI, as well as releasing a new version of your package (triggered by creating a `v{version}` tag); - An initial Git repository with a `.gitignore` file.