Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
avgcampos committed Apr 1, 2024
1 parent 11d0681 commit bbe860e
Showing 1 changed file with 6 additions and 13 deletions.
19 changes: 6 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ The following python packages are required to run myfempy. Before to install myf

## Tutorial

A **Basic Tutorial** is available [here]().
A **Basic Tutorial** is available [here](https://myfempy.readthedocs.io/en/latest/tutorial/).

Many **Examples** are available [here](https://github.com/avgcampos/myfempy/tree/main/examples).

Expand All @@ -103,23 +103,20 @@ The **Web Documentation** is available on [Read the Docs](https://myfempy.readth

The **User's Manual**(pdf) is available on [manual_myfempy](https://myfempy.readthedocs.io/en/latest/user_guide/).

To compile the documentation use *sphinx* in the **\doc** folder. Do,
To compile the documentation use *mkdocs* in the **\docs** folder.

```bash

>> make html {in the root folder where the index.rst file is} --> This command generates *.html* files
>> make doc

```

## Release

The all release versions is available [here](https://github.com/easycae-3d/myfempy/releases)
This command generates *.html* files

## Features
## Release

The *main myfempy features* are available here:
The all release versions is available [here](https://github.com/avgcampos/myfempy/releases)

- [Features List](https://github.com/easycae-3d/myfempy/blob/main/docs/Myfempy%20Features.pdf)

## License

Expand Down Expand Up @@ -168,10 +165,6 @@ url = {https://doi.org/10.5281/zenodo.6958796}

-----------

## Changelog

The changelog is available [here](https://github.com/easycae-3d/myfempy/wiki/Changelog)

# Project tree structure

```bash
Expand Down

0 comments on commit bbe860e

Please sign in to comment.