-
Notifications
You must be signed in to change notification settings - Fork 43
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
6 changed files
with
303 additions
and
265 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,14 +1,17 @@ | ||
[![Build Status](https://app.travis-ci.com/FreeFem/FreeFem-doc.svg?branch=master)](https://travis-ci.com/FreeFem/FreeFem-doc) | ||
[![Doc build (HTML & PDF)](https://github.com/FreeFem/FreeFem-doc/actions/workflows/sphinx.yml/badge.svg?branch=master)](https://github.com/FreeFem/FreeFem-doc/actions/workflows/sphinx.yml) | ||
|
||
# FreeFEM documentation | ||
|
||
The [FreeFEM](https://freefem.org/) documentation is a collaborative effort. We welcome all contributions, do not hesitate to submit a pull request. | ||
|
||
## View the documentation | ||
|
||
Visit the [Documentation website](https://doc.freefem.org) or download the [PDF](https://doc.freefem.org/pdf/FreeFEM-documentation.pdf). The PDF is re-generated automatically after each GitHub commit. | ||
|
||
## Install the documentation | ||
|
||
FreeFEM-doc uses [Sphinx](http://www.sphinx-doc.org/en/master/), have a look at the [sphinx installation](sphinx.md) | ||
|
||
## How to contribute | ||
|
||
Have a look at the [contributing file](CONTRIBUTING.md) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.