https://github.com/pgbiel/glistix-example

Test example
https://github.com/pgbiel/glistix-example

Last synced: about 1 month ago
JSON representation

Test example

• Host: GitHub
• URL: https://github.com/pgbiel/glistix-example
• Owner: PgBiel
• License: mit
• Created: 2024-04-26T03:47:07.000Z (8 months ago)
• Default Branch: main
• Last Pushed: 2024-04-26T04:40:26.000Z (8 months ago)
• Last Synced: 2024-04-26T05:22:34.419Z (8 months ago)
• Language: Nix
• Size: 11.7 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# glistix_example

[![Package Version](https://img.shields.io/hexpm/v/glistix_example)](https://hex.pm/packages/glistix_example)

[![Hex Docs](https://img.shields.io/badge/hex-docs-ffaff3)](https://hexdocs.pm/glistix_example/)

```sh

glistix add glistix_example

```

```gleam

import glistix_example

pub fn main() {

  // TODO: An example of the project in use

}

```

**Note:** This is a Glistix project, and as such may require the

[Glistix compiler](https://github.com/glistix/glistix) to be used.

Further documentation can be found at .

## Importing from Nix

To import this project from Nix, first fetch its source (through a Flake input,

using `builtins.fetchGit`, cloning to a local path, or some other way), import

the Flake or the `default.nix` file, and run `lib.loadGlistixPackage { }`.

For example:

```nix

let

  # Assuming the project was cloned to './path/to/project'

  glistix_example = import ./path/to/project;

  # Use 'loadGlistixPackage { module = "module/name"; }' to pick a module

  package = glistix_example.lib.loadGlistixPackage { };

  result = package.main { };

in result

```

## Development

```sh

nix develop   # Optional: Spawn a shell with glistix

glistix run   # Run the project

glistix test  # Run the tests

```