Skip to content

Commit 70f105d

Browse files
authored
Enhance documentation with quick start and API reference
1 parent 9ae1ed0 commit 70f105d

File tree

1 file changed

+14
-2
lines changed

1 file changed

+14
-2
lines changed

docs/src/index.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,19 @@ CurrentModule = JuDO
99
JuDO is a domain-specific modeling language for dynamic optimization. It extends the syntax of [JuMP.jl](https://jump.dev/) to support infinite-dimensional optimization variables and differential equations.
1010

1111
## Installation
12-
1312
```julia
14-
import Pkg
13+
using Pkg
1514
Pkg.add("JuDO")
15+
```
16+
17+
## Quick Start
18+
```julia
19+
using JuDO
20+
21+
# Your example here
22+
```
23+
24+
## API Reference
25+
```@autodocs
26+
Modules = [JuDO]
27+
```

0 commit comments

Comments
 (0)