Skip to content

Commit 8a9deae

Browse files
authored
Merge pull request #2622 from ERGO-Code/docs-readme
docs readme
2 parents d8a0946 + 978a958 commit 8a9deae

File tree

1 file changed

+27
-0
lines changed

1 file changed

+27
-0
lines changed

docs/README.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Documentation
2+
3+
This directory contains the source files for the [documentation](https://ergo-code.github.io/HiGHS).
4+
5+
## Editing the documentation
6+
7+
To edit the documentation, checkout a branch and edit the Markdown files in the
8+
`src` directory.
9+
10+
## Building the documentation
11+
12+
To build locally, [install Julia](https://julialang.org/downloads/), then (from the `docs` directory) run:
13+
14+
``` bash
15+
$ julia make.jl
16+
```
17+
18+
The first time you run this command, Julia will download and install the
19+
necessary packages. This may take a couple of minutes.
20+
21+
The website is generated in the `build/` folder. To check it out, load
22+
`build/index.html` in your browser.
23+
24+
## Deploying the documentation
25+
26+
The documentation is automatically built and deployed by a GitHub action. You
27+
should not check the `build/` directory into git.

0 commit comments

Comments
 (0)