Skip to content

Commit 4274dd2

Browse files
committed
Add installation and contributing bits again
1 parent 1e92de5 commit 4274dd2

File tree

2 files changed

+29
-5
lines changed

2 files changed

+29
-5
lines changed

docs/pages.jl

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
# Put in a separate page so it can be used by SciMLDocs.jl
22

33
pages = ["index.md",
4-
"Tutorials" => Any["tutorials/linear.md"
4+
"Tutorials" => Any["tutorials/linear.md"
55
"tutorials/caching_interface.md"],
6-
"Basics" => Any["basics/LinearProblem.md",
6+
"Basics" => Any["basics/LinearProblem.md",
77
"basics/common_solver_opts.md",
88
"basics/CachingAPI.md",
99
"basics/Preconditioners.md",
1010
"basics/FAQ.md"],
11-
"Solvers" => Any["solvers/solvers.md"],
12-
"Advanced" => Any["advanced/developing.md"
11+
"Solvers" => Any["solvers/solvers.md"],
12+
"Advanced" => Any["advanced/developing.md"
1313
"advanced/custom.md"],
1414
]

docs/src/index.md

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,33 @@ control algorithm swapping. It also interfaces with the
77
[ModelingToolkit.jl](https://mtk.sciml.ai/dev/) world of symbolic modeling to
88
allow for automatically generating high-performance code.
99

10+
Performance is key: the current methods are made to be highly performant on
11+
scalar and statically sized small problems, with options for large-scale systems.
12+
If you run into any performance issues, please file an issue.
13+
14+
## Installation
15+
16+
To install LinearSolve.jl, use the Julia package manager:
17+
18+
```julia
19+
using Pkg
20+
Pkg.add("LinearSolve")
21+
```
22+
23+
## Contributing
24+
25+
- Please refer to the
26+
[SciML ColPrac: Contributor's Guide on Collaborative Practices for Community Packages](https://github.com/SciML/ColPrac/blob/master/README.md)
27+
for guidance on PRs, issues, and other matters relating to contributing to ModelingToolkit.
28+
- There are a few community forums:
29+
- the #diffeq-bridged channel in the [Julia Slack](https://julialang.org/slack/)
30+
- [JuliaDiffEq](https://gitter.im/JuliaDiffEq/Lobby) on Gitter
31+
- on the [Julia Discourse forums](https://discourse.julialang.org)
32+
- see also [SciML Community page](https://sciml.ai/community/)
33+
1034
## Roadmap
1135

1236
Wrappers for every linear solver in the Julia language is on the roadmap. If
1337
there are any important ones that are missing that you would like to see added,
1438
please open an issue. The current algorithms should support automatic differentiation.
15-
Pre-defined preconditioners would be a welcome addition.
39+
Pre-defined preconditioners would be a welcome addition.

0 commit comments

Comments
 (0)