Skip to content

Commit e73a76b

Browse files
authored
Merge pull request #8 from guimarqu/issue7
Documentation for installation & improve error message when julia binary not found
2 parents 8768aac + 1feda28 commit e73a76b

File tree

2 files changed

+13
-1
lines changed

2 files changed

+13
-1
lines changed

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,15 @@
22

33
This extension adds support for the [Julia](https://julialang.org/) language in
44
the [zed](https://zed.dev) editor.
5+
6+
7+
### Installing Julia / Zed / Zed Julia extension
8+
1. Install Julia for your platform: https://julialang.org/downloads/
9+
2. Install Zed for your platform: https://zed.dev/download
10+
3. Start Zed.
11+
4. Inside Zed, go to the extensions view by
12+
executing the ``zed: extensions`` command (click Zed->Extensions).
13+
5. In the extensions view, simply search for the term ``julia`` in the search box, then select the extension named ``Julia`` and click the install button. You might have to restart Zed after this step.
14+
15+
The Julia Zed extension looks for your Julia binary in the standard locations.
16+
Make sure that the Julia binary is on your ``PATH``.

src/julia.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ impl zed::Extension for JuliaExtension {
1414
worktree: &zed::Worktree,
1515
) -> Result<zed::Command> {
1616
let Some(julia_bin) = worktree.which("julia") else {
17-
return Err("julia not available".to_string());
17+
return Err("Unable to find julia binary. Make sure the PATH variable contains the directory where the julia binary is located.".to_string());
1818
};
1919
Ok(zed::Command {
2020
command: julia_bin.to_string(),

0 commit comments

Comments
 (0)