Skip to content

Commit

Permalink
move 'sharing and using your package' to 'getting started'
Browse files Browse the repository at this point in the history
  • Loading branch information
PgBiel committed Apr 23, 2024
1 parent 69a2cfc commit b189674
Show file tree
Hide file tree
Showing 4 changed files with 3 additions and 3 deletions.
2 changes: 1 addition & 1 deletion src/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion src/getting-started/basic-usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
File renamed without changes.
2 changes: 1 addition & 1 deletion src/using-compiler/command-line-interface.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down

0 comments on commit b189674

Please sign in to comment.