commit 1981e89d46f4ad70ca3bcf3fcf35bd627c75c7f7 Author: Antonio J. Delgado Date: Fri Mar 7 15:07:16 2025 +0200 first commit diff --git a/README.md b/README.md new file mode 100644 index 0000000..4a642f5 --- /dev/null +++ b/README.md @@ -0,0 +1,33 @@ +# pass_helper + +## Requirements + +## Installation + +### Linux + +To install for example in your ~/.local/bin folder: +```bash +./install.sh --destination ~/.local/bin +``` + +To install system-wide: +```bash +sudo ./install.sh --destination /usr/local/bin +``` + +Change your configuration file in "${HOME}/.config/pass_helper.conf" (see the example in the config folder). + +### Windows (from PowerShell) + +Ensure you have "C:\Users\${env:USERNAME}\AppData\Roaming\Python\Python${python_version}\Scripts\" in your Path environment variable. + + ```powershell +& $(where.exe pip).split()[0] install . +``` + +## Usage + + ```bash +pass_helper.sh [--debug-level|-d CRITICAL|ERROR|WARNING|INFO|DEBUG|NOTSET] # Other parameters +```