Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
odow authored Dec 6, 2020
1 parent e2c01f6 commit 817162c
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,16 +6,16 @@ JuMP's documentation is written with [Documenter.jl](https://github.com/JuliaDoc

## Initial setup

To build the documentation, you need to do a series of initialization steps. You
only need to do this once!
To build the documentation, you need to do a series of initialization steps.
However, you only need to do this once!

First, you will need a local copy of JuMP. If you don't have one already, run:
```
$ julia -e 'import Pkg; Pkg.develop("JuMP")'
```

This will create a copy of JuMP at `~/.julia/dev/JuMP`. (On Windows, this will
be located at `C:\\Users\\<your_user_name>\\.julia\dev\JuMP`.) Open a terminal,
be located at `C:\\Users\\<your_user_name>\\.julia\\dev\\JuMP`.) Open a terminal,
and `cd` to that directory:
```
$ cd ~/.julia/dev/JuMP
Expand All @@ -26,6 +26,8 @@ The next step is to setup the `docs` environment.
$ julia --project=docs -e 'import Pkg; Pkg.instantiate(); Pkg.develop(Pkg.PackageSpec(path="."))'
```

Now you're ready to build the documentation.

## Building the docs

Build the docs as follows:
Expand Down

0 comments on commit 817162c

Please sign in to comment.