Update developer_notes.md

simonsobs · Feb 19, 2022 · 0fbd19f · 0fbd19f
1 parent 9f9e9d0
commit 0fbd19f
Showing 1 changed file with 4 additions and 3 deletions.
diff --git a/docs/src/developer_notes.md b/docs/src/developer_notes.md
@@ -6,7 +6,7 @@ CurrentModule = Pixell
 
 If you're new to the [Julia language](https://julialang.org/), my favorite tutorial is this [Introduction to Julia for Quantitative Economics](https://julia.quantecon.org/intro.html). Sections 1-13 are the most relevant if you are an astronomer, but some of later numerical techniques can also be useful. Computing clusters will often have a Julia module; make sure you load a Julia version 1.6 or later. 
 
-For your development computer, download the [precompiled binaries](https://julialang.org/downloads/) and add the Julia executable to your `$PATH`. We **strongly** advise against using a package manager to install Julia. The Julia compiler has a heavily modified glibc (similar to Rust), which many package managers misconfigure (such as the AUR). 
+For your development computer, download the [precompiled binaries](https://julialang.org/downloads/) and add the Julia executable to your `$PATH`. Do not use a package manager to install Julia. The Julia compiler has a heavily modified glibc, which many package managers misconfigure (such as the AUR). This problem is also faced by Rust.
 
 
 ## Package development
@@ -19,9 +19,10 @@ julia> ] dev git@github.com:simonsobs/Pixell.jl.git
 
 By default, this will place a copy of this package's repository in your home directory, `~/.julia/dev/Pixell`. Changes to the code in this folder will be reflected in your global environment.
 
-It can be helpful to write documentation with live preview. This is accomplished with the [LiveServer](https://github.com/tlienart/LiveServer.jl) package. If you have a standard Julia installlation, you can run from the command line,
+It can be helpful to write documentation alongside a live preview. This is accomplished with the [LiveServer](https://github.com/tlienart/LiveServer.jl) package. If you have a standard Julia installlation, you can run from the command line,
 
 ```bash
-julia --project=$HOME/.julia/dev/Pixell/docs -e "using Pixell, LiveServer; servedocs()"
+cd $HOME/.julia/dev/Pixell
+julia --project=. -e "using Pixell, LiveServer; servedocs()"
 ```
 This will render HTML pages and provide an HTTP server for local previews. The documentation will automatically update when you make changes.