docs: document Linux build and prebuilt binary installation
This commit is contained in:
1 parent
43c50a889d
commit
6eb27b7cd6
1 file changed
+17
-3
@@ -2,16 +2,30 @@
|
|||||||
|
|
||||||
A Python-based command-line interface for interacting with Obsidian vaults. Manage notes directly from the terminal without opening Obsidian.
|
A Python-based command-line interface for interacting with Obsidian vaults. Manage notes directly from the terminal without opening Obsidian.
|
||||||
|
|
||||||
## Building the Windows Executable (.exe)
|
## Building a Standalone Executable
|
||||||
|
|
||||||
You can build a standalone Windows executable using PyInstaller:
|
The same `onyx.spec` builds on both Windows and Linux — PyInstaller doesn't
|
||||||
|
cross-compile, so build natively on each platform:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
pip install pyinstaller
|
pip install pyinstaller
|
||||||
python -m PyInstaller onyx.spec
|
python -m PyInstaller onyx.spec
|
||||||
```
|
```
|
||||||
|
|
||||||
The resulting `onyx.exe` will be found in the `dist` folder.
|
- Windows produces `dist/onyx.exe`
|
||||||
|
- Linux produces `dist/onyx` (no extension)
|
||||||
|
|
||||||
|
Prebuilt binaries for both platforms are also attached to each release:
|
||||||
|
https://gitea.mithrilforge.dev/olivier/onyx-cli/releases
|
||||||
|
|
||||||
|
### Installing the Linux binary
|
||||||
|
|
||||||
|
Drop the binary (built or downloaded) anywhere on your `PATH`:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
chmod +x onyx
|
||||||
|
mv onyx ~/.local/bin/onyx # or /usr/local/bin/onyx (needs sudo)
|
||||||
|
```
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
|
|||||||
Reference in new issue
Block a user