diff --git a/Readme.md b/Readme.md index d66a4b0..0cce438 100644 --- a/Readme.md +++ b/Readme.md @@ -11,21 +11,31 @@ To enable clone or fetch or pull using `git pear: ## Installation -It is necessary for corresponding binaries to be in `$PATH`, thus gitpear needs to be installed globally +It is necessary for corresponding binaries to be in `$PATH`, thus gitpear needs to be installed globally. +NOTE: application home directory will be created in `~/.gitpear` - this may require `sudo`. -### From remote +### From npm ```sh -npm install -g git@github.com:dzdidi/gitpear.git +npm install -g gitpear ``` -### From local +### From git ```sh git clone git@github.com:dzdidi/gitpear.git cd gitpear +npm install npm link ``` -NOTE: application home directory will be created in `~/.gitpear` - this may require `sudo` +### From git + Nix +```sh +git clone git@github.com:dzdidi/gitpear.git +cd gitpear +npm install +npm nix +``` + +See `./result` - for binaries build by nix. To make the available add to path by running `PATH="${PATH:+${PATH}:}${PWD}/result/bin/"` ## diff --git a/bin/nix.sh b/bin/nix.sh new file mode 100755 index 0000000..b5aabce --- /dev/null +++ b/bin/nix.sh @@ -0,0 +1,4 @@ +#!/bin/sh + +rm -rf result +nix build '.#' diff --git a/package.json b/package.json index 4e326d0..db04966 100644 --- a/package.json +++ b/package.json @@ -7,6 +7,7 @@ "types": "tsc src/*.js --declaration --allowJs --emitDeclarationOnly --outDir types --target es2015", "lint": "standard --fix", "preinstall": "./bin/preinstall.sh", + "nix": "./bin/nix.sh", "pretest": "tar xzf test_home.tar.gz -C . " }, "bin": {