Installation instructions.
parent
57c4fbf0a4
commit
f88522aa06
|
@ -9,7 +9,11 @@
|
|||
/test/data
|
||||
/test/scenarios/inherited/.envrc
|
||||
|
||||
# Rust
|
||||
# nix
|
||||
result
|
||||
result-bin/
|
||||
|
||||
# rust
|
||||
**/*.rs.bk
|
||||
*.pdb
|
||||
debug/
|
||||
|
|
33
README.md
33
README.md
|
@ -13,7 +13,38 @@ overwriting local configurations for one or more packages.
|
|||
|
||||
## Installation
|
||||
|
||||
TODO
|
||||
Currently `nix` is the only distribution channel available. You can run directly
|
||||
from the shell like so:
|
||||
|
||||
```bash
|
||||
$ nix shell github:jrpotter/homesync/main
|
||||
```
|
||||
|
||||
Likewise, you can install the binary using [home-manager](https://github.com/nix-community/home-manager):
|
||||
|
||||
```nix
|
||||
{
|
||||
inputs = {
|
||||
homesync.url = "github:jrpotter/homesync/main";
|
||||
};
|
||||
|
||||
# ...
|
||||
|
||||
configuration = { ... }: {
|
||||
home.packages = [
|
||||
homesync.defaultPackage.${system}
|
||||
];
|
||||
};
|
||||
}
|
||||
```
|
||||
|
||||
Lastly, you can always just build from source:
|
||||
|
||||
```bash
|
||||
$ git clone https://github.com/jrpotter/homesync.git
|
||||
$ cd homesync
|
||||
$ cargo build --release
|
||||
```
|
||||
|
||||
## Configuration
|
||||
|
||||
|
|
Loading…
Reference in New Issue