diff --git a/README.md b/README.md index 53168efe5..a0584b691 100644 --- a/README.md +++ b/README.md @@ -23,11 +23,13 @@ Porting to [Mimi 0.5.0](https://github.com/mimiframework/Mimi.jl/releases/tag/v0 ## Installation -Mimi is an installable package. To install Mimi, use the following: +Mimi is an installable package. To install Mimi, first enter Pkg REPL mode by typing `]`, and then use the following: -```` -Pkg.add("Mimi") -```` +```julia +pkg> add Mimi +``` + +You may then exit Pkg REPL mode with a single backpace. ## Mimi Registry diff --git a/docs/src/index.md b/docs/src/index.md index c1c342569..0fba4ffb0 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -6,13 +6,13 @@ Mimi is a package that provides a component model for [integrated assessment mod ## Installation -Mimi is an installable package. To install Mimi, use the following: +Mimi is an installable package. To install Mimi, first enter Pkg REPL mode by typing `]`, and then use the following: ```julia -Pkg.add("Mimi") +pkg> add Mimi ``` -For more complete setup instructions, follow the [Installation Guide](@ref). +You may then exit Pkg REPL mode with a single backpace. For more complete setup instructions, follow the [Installation Guide](@ref). ## Mimi Registry diff --git a/docs/src/installation.md b/docs/src/installation.md index 45e8a3baf..2f271960a 100644 --- a/docs/src/installation.md +++ b/docs/src/installation.md @@ -8,15 +8,17 @@ Mimi requires the programming language [julia](http://julialang.org/) to run. Yo ## Installing Mimi -Once julia is installed, start julia and you should see a julia command prompt. To install the Mimi package, issue the following command: +Once julia is installed, start julia and you should see a julia command prompt. To install the Mimi package, issue the following command from the Pkg REPL mode, which is entered by typing `]` and exited with a single backspace: + ```julia -julia> Pkg.add("Mimi") +pkg> add Mimi ``` You only have to run this command once on your machine. -As Mimi gets improved we will release new versions of the package. To make sure you always have the latest version of Mimi installed, you can run the following command at the julia prompt: +As Mimi gets improved we will release new versions of the package. To make sure you always have the latest version of Mimi installed, you can run the following command at the julia Pkg REPL: + ```julia -julia> Pkg.update() +pkg> update ``` This will update *all* installed packages to their latest version (not just the Mimi package).