Skip to content

Use pkg mode for all instructions #483

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
May 20, 2019
Merged

Use pkg mode for all instructions #483

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
816bf83
Use pkg mode for all instructions
lrennels May 16, 2019
9bef601
Fix pkg mode syntax
lrennels May 16, 2019
71795ea
Remove parenthesis
lrennels May 16, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
6 changes: 3 additions & 3 deletions docs/src/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
10 changes: 6 additions & 4 deletions docs/src/installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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).

Expand Down