Skip to content

Commit 3e99359

Browse files
committed
Add one-click installer
1 parent f10eb01 commit 3e99359

2 files changed

Lines changed: 354 additions & 6 deletions

File tree

README.md

Lines changed: 39 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,31 @@ Command-line tool for using DSLogic Plus devices without the DSView GUI. Capture
44

55
## Quick Start
66

7+
### One-line install (macOS/Linux)
8+
9+
Install the latest published release bundle into `~/.local/opt/dsview-cli` and add a launcher in `~/.local/bin`:
10+
11+
```bash
12+
curl -fsSL https://raw.githubusercontent.com/LISTENAI/dsview-cli/main/scripts/install.sh | sh
13+
```
14+
15+
Install a specific version instead:
16+
17+
```bash
18+
curl -fsSL https://raw.githubusercontent.com/LISTENAI/dsview-cli/main/scripts/install.sh | sh -s -- --version v0.1.0
19+
```
20+
21+
The installer keeps the release bundle intact so the executable can still find its sibling `runtime/` and `resources/` directories.
22+
23+
Supported installer targets:
24+
- Linux x86_64, ARM64
25+
- macOS x86_64 (Intel), ARM64 (Apple Silicon)
26+
727
### Build from source
828

929
```bash
1030
# Clone with submodules
11-
git clone --recursive https://github.com/yourusername/dsview-cli.git
31+
git clone --recursive https://github.com/LISTENAI/dsview-cli.git
1232
cd dsview-cli
1333

1434
# Build release binary
@@ -20,7 +40,7 @@ cargo build --release
2040
### List connected devices
2141

2242
```bash
23-
./target/release/dsview-cli devices list --format text
43+
dsview-cli devices list --format text
2444
```
2545

2646
Example output:
@@ -34,7 +54,7 @@ Device 1 (handle: 1)
3454
### Capture waveform data
3555

3656
```bash
37-
./target/release/dsview-cli capture \
57+
dsview-cli capture \
3858
--handle 1 \
3959
--sample-rate-hz 100000000 \
4060
--sample-limit 2048 \
@@ -72,7 +92,7 @@ dsview-cli-v0.1.0-x86_64-unknown-linux-gnu/
7292
Use `--resource-dir` to point to a different resource directory:
7393

7494
```bash
75-
./dsview-cli devices list --resource-dir /path/to/custom/resources
95+
dsview-cli devices list --resource-dir /path/to/custom/resources
7696
```
7797

7898
This is the only resource-related flag. The CLI no longer exposes runtime library selection.
@@ -85,13 +105,18 @@ The v1.0 milestone validates the capture-and-export workflow for DSLogic Plus. F
85105

86106
## Platform Support
87107

88-
Pre-built release bundles are available for:
108+
Source builds are supported for:
89109

90110
- **Linux**: x86_64, ARM64
91111
- **macOS**: x86_64 (Intel), ARM64 (Apple Silicon)
92112
- **Windows**: x86_64, ARM64
93113

94-
All platforms use the same CLI interface and bundle structure.
114+
Published release bundles and the one-line installer currently target:
115+
116+
- **Linux**: x86_64, ARM64
117+
- **macOS**: x86_64 (Intel), ARM64 (Apple Silicon)
118+
119+
Windows users should currently build from source.
95120

96121
## Build Prerequisites
97122

@@ -107,6 +132,14 @@ sudo apt-get install \
107132
libfftw3-dev
108133
```
109134

135+
If `devices list` cannot see your hardware as a non-root user, install the bundled udev rule and replug the device:
136+
137+
```bash
138+
sudo cp DSView/DSView/DreamSourceLab.rules /etc/udev/rules.d/99-dsview-cli.rules
139+
sudo udevadm control --reload-rules
140+
sudo udevadm trigger
141+
```
142+
110143
### macOS
111144

112145
```bash

0 commit comments

Comments
 (0)