From d265dae9c3db6d4f838b878f81553b59f9b90074 Mon Sep 17 00:00:00 2001 From: Daylin Morgan Date: Tue, 20 Dec 2022 10:21:42 -0600 Subject: [PATCH] docs: update install instructions --- Makefile | 3 ++- README.md | 10 ++++++++++ 2 files changed, 12 insertions(+), 1 deletion(-) diff --git a/Makefile b/Makefile index ab86a49..1b9b4fd 100644 --- a/Makefile +++ b/Makefile @@ -1,4 +1,5 @@ VERSION ?= $(shell git describe --tags --always --dirty=-dev | sed 's/^v//g') +PREFIX ?= ~/bin VENV_BIN = ./.venv/bin lint: @@ -17,7 +18,7 @@ env: $(VENV_BIN)/pre-commit install --install-hooks install: - ln -sf $(shell pwd)/src/viv.py ~/bin/viv + ln -sf $(shell pwd)/src/viv.py $(PREFIX)/viv uninstall: rm ~/bin/viv diff --git a/README.md b/README.md index 2c77d29..ffe62f8 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,16 @@ # Viv isn't venv ## Setup + +Start by cloning the repo and symlinking the script for access to the CLI. +By default it will symlink `./src/viv.py` to `~/bin/viv`. +You can set `PREFIX` to symlink to a different location. + +```sh +git clone git@github.com:daylinmorgan/viv.git ~/.viv +make install # or PREFIX=~/.local/bin make install +``` + Place this directory on the python path in your rc file. ```sh