From d8e5d899a10cfb04d0814cc4302db181730adf5c Mon Sep 17 00:00:00 2001 From: jbytecode Date: Wed, 6 Mar 2024 12:49:04 +0300 Subject: [PATCH] add documentation badget --- README.md | 4 +++- docs/make.jl | 2 +- docs/src/index.md | 1 + 3 files changed, 5 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index d5c9728..6b9ff7f 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,7 @@ [![Join the chat at https://gitter.im/Comodo.jl](https://badges.gitter.im/Comodo.jl.svg)](https://app.gitter.im/#/room/#comodo:gitter.im?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) ![](assets/img/COMODO.png) [![Mastodon](https://img.shields.io/badge/-MASTODON-%232B90D9?style=for-the-badge&logo=mastodon&logoColor=white)](https://fosstodon.org/@kevinmoerman) +[![Doc](https://img.shields.io/badge/docs-dev-blue.svg)](https://comodo-research.github.io/Comodo.jl/dev/) @@ -18,11 +19,12 @@ Comodo.jl started out as a modern re-implementation in Julia of the MATLAB toolb ```julia pkg> add https://github.com/COMODO-research/Comodo.jl ``` + # Getting started The `examples` folder contains examples on the use of Comodo's functionality. # Documentation -Under construction +[Functional Documentation](https://comodo-research.github.io/Comodo.jl/dev/) # Combinding with finite element analysis For finite element analysis users are encouraged to combine the Comodo capabilities with the open source C++ solver [FEBio](https://febio.org/), e.g. based on the Julia wrapper [FEBio.jl](https://github.com/febiosoftware/FEBio.jl). In addition, users may want to explore the Julia packages [Gridap.jl](https://github.com/gridap/Gridap.jl) and [Ferrite.jl](https://github.com/Ferrite-FEM/Ferrite.jl). diff --git a/docs/make.jl b/docs/make.jl index 7576d7a..ecce595 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -9,7 +9,7 @@ makedocs( sitename="A Julia package for computational (bio)mechanics and computational design", authors = "Kevin-Mattheus-Moerman ", pages = [ - "functions" => "functions.md", + "Functions" => "functions.md", ] ) diff --git a/docs/src/index.md b/docs/src/index.md index d7b59ea..8be8722 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -2,3 +2,4 @@ ___________________ +- [Functions](https://comodo-research.github.io/Comodo.jl/dev/functions/)