Skip to content

Commit 73f0487

Browse files
committed
More edits in the documentation
1 parent 5073beb commit 73f0487

File tree

3 files changed

+9
-13
lines changed

3 files changed

+9
-13
lines changed

docs/make.jl

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,9 @@ pages = [
1414
"Gridap.Arrays" => "Arrays.md",
1515
"Gridap.Fields" => "Fields.md",
1616
"Gridap.Polynomials" => "Polynomials.md",
17+
"Gridap.Integration" => "Integration.md",
1718
"Gridap.ReferenceFEs" => "ReferenceFEs.md",
1819
"Gridap.Geometry" => "Geometry.md",
19-
"Gridap.Integration" => "Integration.md",
2020
"Gridap.FESpaces" => "FESpaces.md",
2121
"Gridap.MultiField" => "MultiField.md",
2222
"Gridap.Visualization" => "Visualization.md",

docs/src/getting-started.md

+3-5
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,11 @@
22

33
## Installation requirements
44

5-
At the moment, Gridap requires at least Julia version 1.1.
6-
7-
Gridap has been tested on Linux and Mac Os operating systems.
5+
Gridap is tested on Linux, but it should be also possible to use it on Mac OS and Windows since it is written exclusively in Julia and it only depends on registered Julia packages.
86

97
## Installation
108

11-
Gridap is a registered package. Thus, the installation should be straight forward using the Julia's package manager [Pkg](https://julialang.github.io/Pkg.jl/v1/): open the Julia REPL (i.e., execute the `julia` binary), type `]` to enter package mode, and install Gridap as follows
9+
Gridap is a registered package. Thus, the installation should be straight forward using the Julia's package manager [Pkg](https://julialang.github.io/Pkg.jl/v1/). To this end, open the Julia REPL (i.e., execute the `julia` binary), type `]` to enter package mode, and install Gridap as follows
1210

1311
```julia
1412
pkg> add Gridap
@@ -21,6 +19,6 @@ For further information about how to install and manage Julia packages, see the
2119

2220
## Further steps
2321

24-
We recommend to follow the [Gridap Tutorials](https://github.com/gridap/Tutorials) in order to get familiar with the library.
22+
We recommend to follow the [Gridap Tutorials](https://gridap.github.io/Tutorials/dev/) in order to get familiar with the library.
2523

2624

docs/src/index.md

+5-7
Original file line numberDiff line numberDiff line change
@@ -18,18 +18,16 @@ The library currently supports linear and nonlinear PDE systems for scalar and v
1818

1919
* The first step for new users is to visit the [Getting Started](@ref) page.
2020

21+
* A set of tutorials written as Jupyter notebooks and html pages are available [here](https://github.com/gridap/Tutorials).
22+
2123
* The detailed documentation is in the [Manual](@ref) section.
2224

2325
* Guidelines for developers of the Gridap project is found in the [Gridap wiki](https://github.com/gridap/Gridap.jl/wiki) page.
2426

25-
## Tutorials
26-
27-
In addition to these documentation pages, a set of tutorials written in Jupyter notebooks are available [here](https://github.com/gridap/Tutorials).
28-
2927
## Julia educational resources
3028

3129
A basic knowledge of the Julia programming language is needed to use the Gridap package.
32-
Here, a list of resources to get started with this programming language.
30+
Here, one can find a list of resources to get started with this programming language.
3331

3432
* First steps to learn Julia form the [Gridap wiki](https://github.com/gridap/Gridap.jl/wiki/Start-learning-Julia) page.
3533
* Official webpage [docs.julialang.org](https://docs.julialang.org/)
@@ -48,11 +46,11 @@ Pages = [
4846
"Arrays.md",
4947
"Fields.md",
5048
"Polynomials.md",
49+
"Integration.md",
5150
"ReferenceFEs.md",
5251
"Geometry.md",
53-
"Integration.md",
5452
"FESpaces.md",
55-
"MutliField.md",
53+
"MultiField.md",
5654
"Visualization.md",
5755
]
5856
```

0 commit comments

Comments
 (0)