Skip to content

Commit af457a7

Browse files
More doc tweaks (#104)
* Editorial pass on TROUBLESHOOTING.md * Move recent release info into the CHANGELOG.md * Updates to README, CHANGELOG, TROUBLESHOOTING files * Add hints about installing and running qStudio and PRQL * Add info about qstudio log files in the home directory; Update info about "first run"
1 parent 3044fb9 commit af457a7

File tree

1 file changed

+20
-2
lines changed

1 file changed

+20
-2
lines changed

TROUBLESHOOTING.md

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,28 @@ The terminal session displays a lot of logging information.
1616
java -jar qstudio.jar
1717
```
1818

19-
4. The `prqlc` binary must be installed and available to qStudio.
20-
* On macOS, the easiest way to install `prqlc` is with
19+
4. qStudio also saves a log of its operations in a _qstudio_ directory
20+
in the user's home directory.
21+
22+
5. The `prqlc` binary must be installed and available to qStudio.
23+
* **On macOS**, the easiest way to install `prqlc` is with
2124
the [Homebrew package manager](https://brew.sh/).
2225
It will install the current binary and make it available on the PATH.
2326
(Homebrew is a terrific tool because it does not
2427
require any superuser permissions,
2528
and saves all its files in a few well-known directories.)
29+
Test the installation by typing `prqlc --version`.
30+
* **On Windows**, the easiest way to install `prqlc` is to use
31+
[winget](https://learn.microsoft.com/en-us/windows/package-manager/winget/).
32+
Use `winget install prqlc`.
33+
You may need to open a new terminal window before testing with `prqlc --version`.
34+
35+
6. **First run:**
36+
On macOS, the operating system will refuse to run qStudio when
37+
you double-click its icon in the Finder.
38+
To solve this, open **System Preferences -> Security & Privacy**.
39+
There will likely be a message to the effect, "qStudio is from
40+
an untrusted developer...".
41+
Click "Open anyway..." and confirm that you want to run the program.
42+
Alternatively, use `java -jar qstudio.jar` as described above.
43+

0 commit comments

Comments
 (0)