Skip to content

Commit

Permalink
doc: Improve instructions on README file (#4)
Browse files Browse the repository at this point in the history
  • Loading branch information
sestrella authored Nov 25, 2024
1 parent 90c0f2f commit 043ed4a
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 1 deletion.
28 changes: 28 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,34 @@ Compared to the AWS CLI, if no parameters are provided to the available
commands, the user would be requested to choose the desired resource from a
list of all tasks running on ECS.

## Installation

Clone the repository:

```
git clone https://github.com/sestrella/iecs.git
```

Download and [install](https://go.dev/dl/) the appropriate Go version. Check
the version constraint on the [go.mod](go.mod) to determine which version to
use.

Compile and generate the binary:

```
go build
```

Copy the binary to a directory in the `PATH`, like `~/.local/bin`:

```
cp iecs ~/.local/bin/iecs
```

> [!NOTE]
> Check that the path where the binary is copied exists in the `PATH`
> environment variable.
## References

- https://aws.github.io/aws-sdk-go-v2/docs/getting-started/
Expand Down
6 changes: 5 additions & 1 deletion flake.nix
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@

systems = import systems;

perSystem = { system, pkgs, ... }: {
perSystem = { config, system, pkgs, ... }: {
_module.args.pkgs = import nixpkgs {
inherit system;
overlays = [ gomod2nix.overlays.default ];
Expand All @@ -29,6 +29,10 @@
src = ./.;
modules = ./gomod2nix.toml;
};

overlayAttrs = {
iecs = config.packages.default;
};
};
};
}

0 comments on commit 043ed4a

Please sign in to comment.