Merge pull request #5 from Kev1CO/documentation

Adapting documentation to pyomeca
pyomeca · Sep 3, 2024 · acb8263 · acb8263
2 parents f50d932 + 891f7c3
commit acb8263
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 10 deletions.
diff --git a/.github/workflows/run_tests_win.yml b/.github/workflows/run_tests_win.yml
@@ -129,9 +129,7 @@ jobs:
       - name: Upload coverage to Codecov
         uses: codecov/codecov-action@v2
         with:
-          #token: ${{ secrets.CODECOV_TOKEN }}
           file: ./coverage.xml
-          #files: ./coverage1.xml, ./coverage2.xml, ./coverage3.xml, ./coverage4.xml
           flags: unittests
           fail_ci_if_error: true
           verbose: true

diff --git a/README.md b/README.md
@@ -9,11 +9,11 @@ To solve the OCP, the robust solver [Ipopt](https://github.com/coin-or/Ipopt) ha
 
 ## Status
 
-| Type          | Status                                                                                                                                                                |
-|---------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| License       | <a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/badge/license-MIT-success" alt="License"/></a>                                         |
-| Code coverage | [![codecov](https://codecov.io/github/Kev1CO/cocofest/graph/badge.svg?token=85XHAQGLWQ)](https://codecov.io/github/Kev1CO/cocofest)                                   |
-| Code climate  | <a href="https://codeclimate.com/github/Kev1CO/cocofest/maintainability"><img src="https://api.codeclimate.com/v1/badges/b9fcbc434d8be931dce7/maintainability" /></a> |
+| Type          | Status                                                                                                                                                                  |
+|---------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| License       | <a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/badge/license-MIT-success" alt="License"/></a>                                           |
+| Code coverage | [![codecov](https://codecov.io/github/Kev1CO/cocofest/graph/badge.svg?token=85XHAQGLWQ)](https://codecov.io/github/Kev1CO/cocofest)                                     |
+| Code climate  | <a href="https://codeclimate.com/github/pyomeca/cocofest/maintainability"><img src="https://api.codeclimate.com/v1/badges/68cd9855a07be8bfb8c5/maintainability" /></a>  |
 
 # Table of Contents 
 
@@ -128,7 +128,7 @@ result = ocp.solve()
 ```
 
 # Examples
-You can find all the available examples in the [examples](https://github.com/Kev1CO/cocofest/tree/main/examples) file.
+You can find all the available examples in the [examples](https://github.com/pyomeca/cocofest/tree/main/examples) file.
 ## Musculoskeletal model driven by FES models
 The following example is a musculoskeletal model driven by the Ding2007 FES model.
 The objective function is to reach a 90° forearm position and 0° arm position at the movement end.
@@ -173,4 +173,5 @@ ocp = OcpFes().prepare_ocp(model=DingModelFrequency(sum_stim_truncation=5))
 But if you use `Cocofest` in your research, please kindly cite this zenodo link [10.5281/zenodo.10427934](https://doi.org/10.5281/zenodo.10427934).
 
 # Acknowledgements
+The software development was supported by Ingénierie de technologies interactives en réadaptation [INTER #160 OptiStim](https://regroupementinter.com/fr/mandat/160-optistim/).
 The Cocofest [logo](docs/cocofest_logo.png) has been design by [MaxMV](https://www.instagram.com/max_mv3/)
diff --git a/docs/contributing.md b/docs/contributing.md
@@ -1,14 +1,14 @@
 # Contributing to `cocofest`
 We warmly welcome all contributions, including bug reports, bug fixes, documentation improvements, enhancements, and innovative ideas. 
-But first take a look at our list of [`issues`](https://github.com/Kev1CO/cocofest/issues) on GitHub.
+But first take a look at our list of [`issues`](https://github.com/pyomeca/cocofest/issues) on GitHub.
 You might find issues that already matches your needs.
 
 
 ## Forking `cocofest`
 
 To make contributions, you'll need to create your own fork of the cocofest repository. Here's how to get started:
 
-1. Visit the [cocofest project page](https://github.com/Kev1CO/cocofest).
+1. Visit the [cocofest project page](https://github.com/pyomeca/cocofest).
 2. Click the Fork button to create your personal fork.
 
 After forking, clone your repository to your local machine using the following command: