Updated usage

.github/workflows/build_binaries.yml

@@ -29,11 +29,11 @@ jobs:
         run: poetry install
 
       - name: Build Pyinstaller
-        run: poetry run pyinstaller --onefile ./src/zeal_cli.py --name zeal-cli-${{ matrix.os[1] }}
+        run: poetry run pyinstaller --onefile ./src/zeal_cli.py --name zeal-cli
 
       - name: Upload Executables
         uses: softprops/[email protected]
         with:
           files: |
-            dist/zeal-cli-${{ matrix.os[1] }}
-            dist/zeal-cli-${{ matrix.os[1] }}.exe
+            dist/zeal-cli
+            dist/zeal-cli.exe

docs/README.md

@@ -3,7 +3,7 @@ A Command-Line-Interface for managing installed Zeal Docsets.
 
 Just like Zeal, Zeal_CLI sources docsets from Dash.
 ## Usage for Non-Contributors
-View the [usage documentation](/usage.md) for using instructions.
+View the [usage documentation](usage.md) for using instructions.
 
 ## Documentation
 To view all the available documentation for this project, please see the [Documents Index](INDEX.md)

docs/usage.md

@@ -1,13 +1,14 @@
 # Usage
 Right now, Zeal_CLI only supports Linux.
 
-## Installation - Linux
+# Installation
+
+## Linux - From Binary
 1. Download the linux build from the most recent [release](https://github.com/Morpheus636/zeal_cli/releases)
-2. Give the file executable permissions using `chmod +x /path/to/executable`
-3. At this point, you can run the file explicitly with `/path/to/executable/`, but it's reccommended that you do the following:
-   1. Rename the executable to just `zeal-cli`.
-   2. Copy (or symlink) it to a location on PATH (I personally use `~/.local/bin/` but you can use whatever you want).
-   - These steps make it so you can run the executable as just `zeal-cli`
+2. Create a directory `~/zeal-cli/`
+3. Copy the linux build to that directory.
+4. Give the file executable permissions (`chmod +x ~/zeal-cli/zeal-cli`)
+5. Symlink it to a location on PATH (I personally use `~/.local/bin/`)
 
 ## Usage
-All usage information can be found by running the executable with the --help flag.
+Usage information can be found by running `zeal-cli --help`