From d56a2535266faddaf0df91893e430d408020ab84 Mon Sep 17 00:00:00 2001 From: kirbylife Date: Mon, 6 Nov 2023 19:48:35 -0600 Subject: [PATCH] Add instructions tu install it trough PyPI --- README.md | 20 +++++++++++++++++--- 1 file changed, 17 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index f560f9d..0161abd 100644 --- a/README.md +++ b/README.md @@ -14,13 +14,27 @@ nxexpo it's a simple tool to define environment variables on-the-fly and persist - [MyPy](https://www.mypy-lang.org/) ## Installation + +### Intalation trough PyPI +To install the latest stable version follow the commands: +```Bash +$ pip install nvexpo --user +``` +You can also use [pipx](https://pypa.github.io/pipx/) to install it: +```Bash +$ pipx install nvexpo +``` + +### From the source To install from the source follow the commands: ```Bash $ poetry build $ pip install dist/nvexpo*.whl ``` -And add the follow line to your `.bashrc` file: +## Preparation + +Add the following line to your `.bashrc` file: ```Bash eval "$(nvexpo init bash)" ``` @@ -50,8 +64,8 @@ $ works!! ``` ## Why? -The main motivation for creating this tool was that in my work I like to have the Git branch I'm working on in `$branch`, but it's annoying to have to create it every time I restart or close the terminal I was working on. -I could add it to `.bashrc` directly, but I would have to do it every time I have to work on a new branch and it wasn't comfortable. +The main motivation for creating this tool was that in my work I like to have the Git branch I'm working on in `$branch`, but it's annoying to have to create it every time I restart or close the terminal I was working on. +I could add it to `.bashrc` directly, but I would have to do it every time I have to work on a new branch and it wasn't comfortable. So now instead of having to type: ```Bash branch="super_useful_change"