Add instructions tu install it trough PyPI
parent
24433d5c23
commit
d56a253526
20
README.md
20
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/)
|
- [MyPy](https://www.mypy-lang.org/)
|
||||||
|
|
||||||
## Installation
|
## 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:
|
To install from the source follow the commands:
|
||||||
```Bash
|
```Bash
|
||||||
$ poetry build
|
$ poetry build
|
||||||
$ pip install dist/nvexpo*.whl
|
$ pip install dist/nvexpo*.whl
|
||||||
```
|
```
|
||||||
|
|
||||||
And add the follow line to your `.bashrc` file:
|
## Preparation
|
||||||
|
|
||||||
|
Add the following line to your `.bashrc` file:
|
||||||
```Bash
|
```Bash
|
||||||
eval "$(nvexpo init bash)"
|
eval "$(nvexpo init bash)"
|
||||||
```
|
```
|
||||||
|
@ -50,8 +64,8 @@ $ works!!
|
||||||
```
|
```
|
||||||
|
|
||||||
## Why?
|
## 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.
|
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.
|
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:
|
So now instead of having to type:
|
||||||
```Bash
|
```Bash
|
||||||
branch="super_useful_change"
|
branch="super_useful_change"
|
||||||
|
|
Loading…
Reference in New Issue