daylin/viv
1
0
Fork 0
mirror of https://github.com/daylinmorgan/viv.git synced 2024-12-22 02:30:44 -06:00
Code Issues Projects Releases Packages Wiki Activity

docs: update install instructions

Browse source
This commit is contained in:
Daylin Morgan 2022-12-20 10:21:42 -06:00
parent 8e4cb1d3b2
commit d265dae9c3
2 changed files with 12 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
Makefile
View file

@ -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

10
README.md
View file

@ -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