Skip to content

Commit

Permalink
doc: update usage instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
nrdxp committed Aug 7, 2024
1 parent 5c897ac commit 3d43c4c
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 3 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
.direnv
result
13 changes: 10 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,12 +43,19 @@ code without having to perform a full evaluation. This could be used, e.g. to sh

## Usage

> Note: this is an implementation detail, and the true entrypoint should be considered the TOML manifest file.
> The future cli will honor this and hide this detail from the user.
```nix
let
compose = import ./path/to/this/module/system;
myModule = compose ./path/to/my/atom/root;
atom = builtins.fetchGit "https://github.com/ekala-project/atom";
fromManifest = import "${atom}/src/atom/fromManifest.nix";
in
myModule
fromManifest {
features = [
# optional feature flags
];
} ./src/dev.toml # or whatever your manifest is called
```

## Best Practices
Expand Down

0 comments on commit 3d43c4c

Please sign in to comment.