From cb59679eefbf3f9f8a4480ec189b01ad8f7ce5a4 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Sat, 6 Sep 2025 19:17:11 +0000 Subject: [PATCH] Update README with latest ABOUT.md, INSTALL.md, CONTRIBUTING.md and badges --- README.md | 59 ++++++++++++++++++++++++++++++------------------------- 1 file changed, 32 insertions(+), 27 deletions(-) diff --git a/README.md b/README.md index 3e07948..ba37d88 100644 --- a/README.md +++ b/README.md @@ -1,48 +1,53 @@ # Tutorials.jl -[ci-img]: https://github.com/control-toolbox/Tutorials.jl/actions/workflows/CI.yml/badge.svg?branch=main -[ci-url]: https://github.com/control-toolbox/Tutorials.jl/actions/workflows/CI.yml?query=branch%3Amain + -[co-img]: https://codecov.io/gh/control-toolbox/Tutorials.jl/branch/main/graph/badge.svg?token=YM5YQQUSO3 -[co-url]: https://codecov.io/gh/control-toolbox/Tutorials.jl +The Tutorials.jl repo is part of the [control-toolbox ecosystem](https://github.com/control-toolbox). -[doc-dev-img]: https://img.shields.io/badge/docs-dev-8A2BE2.svg -[doc-dev-url]: https://control-toolbox.org/Tutorials.jl/dev/ +| **Category** | **Badge** | +|-----------------------|-----------| +| **Documentation** | [![Stable Docs](https://img.shields.io/badge/docs-stable-blue.svg)](https://control-toolbox.org/Tutorials.jl/stable/) [![Dev Docs](https://img.shields.io/badge/docs-dev-8A2BE2.svg)](https://control-toolbox.org/Tutorials.jl/dev/) | +| **CI / Build** | [![Build Status](https://github.com/control-toolbox/Tutorials.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/control-toolbox/Tutorials.jl/actions/workflows/CI.yml?query=branch%3Amain) | +| **Test Coverage** | [![Coverage](https://codecov.io/gh/control-toolbox/Tutorials.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/control-toolbox/Tutorials.jl) | +| **Release / Version** | [![Release](https://juliahub.com/docs/General/Tutorials/stable/version.svg)](https://github.com/control-toolbox/Tutorials.jl/releases) | +| **License** | [![License](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/control-toolbox/Tutorials.jl/blob/master/LICENSE) | +| **Code Style / Quality** | [![Code Style: Blue](https://img.shields.io/badge/code%20style-blue-4495d1.svg)](https://github.com/JuliaDiff/BlueStyle) [![Aqua.jl](https://raw.githubusercontent.com/JuliaTesting/Aqua.jl/master/badge.svg)](https://github.com/JuliaTesting/Aqua.jl) | -[doc-stable-img]: https://img.shields.io/badge/docs-stable-blue.svg -[doc-stable-url]: https://control-toolbox.org/Tutorials.jl/stable/ +## About control-toolbox -[licence-img]: https://img.shields.io/badge/License-MIT-yellow.svg -[licence-url]: https://github.com/control-toolbox/Tutorials.jl/blob/master/LICENSE +The **control-toolbox** ecosystem brings together + + Julia + packages for mathematical control and its applications. -[aqua-img]: https://raw.githubusercontent.com/JuliaTesting/Aqua.jl/master/badge.svg -[aqua-url]: https://github.com/JuliaTesting/Aqua.jl +- The root package, [OptimalControl.jl](https://github.com/control-toolbox/OptimalControl.jl), provides tools to model and solve optimal control problems defined by ordinary differential equations. It supports both direct and indirect methods, and can run on CPU or GPU. -[blue-img]: https://img.shields.io/badge/code%20style-blue-4495d1.svg -[blue-url]: https://github.com/JuliaDiff/BlueStyle +

+ + Documentation OptimalControl.jl + +

-This repo is part of the [control-toolbox ecosystem](https://github.com/control-toolbox). -The control-toolbox ecosystem gathers Julia packages for mathematical control and applications. The root package is [OptimalControl.jl](https://github.com/control-toolbox/OptimalControl.jl) which aims to provide tools to model and solve optimal control problems with ordinary differential equations by direct and indirect methods, both on CPU and GPU. +- Complementing it, [OptimalControlProblems.jl](https://github.com/control-toolbox/OptimalControlProblems.jl) offers a curated collection of benchmark optimal control problems formulated with ODEs in Julia. Each problem is available both in the **OptimalControl** DSL and in **JuMP**, with discretised versions ready to be solved using the solver of your choice. This makes the package particularly useful for benchmarking and comparing different solution strategies. -[![doc OptimalControl.jl](https://img.shields.io/badge/Documentation-OptimalControl.jl-blue)](http://control-toolbox.org/OptimalControl.jl) - -| **Name** | **Badge** | -:-------------------|:------------------| -| Documentation | [![Documentation][doc-stable-img]][doc-stable-url] [![Documentation][doc-dev-img]][doc-dev-url] | -| Code Status | [![Build Status][ci-img]][ci-url] [![Covering Status][co-img]][co-url] [![Aqua.jl][aqua-img]][aqua-url] [![Code Style: Blue][blue-img]][blue-url] | -| Licence | [![License: MIT][licence-img]][licence-url] | +

+ + Documentation OptimalControlProblems.jl + +

## Contributing [issue-url]: https://github.com/control-toolbox/Tutorials.jl/issues [first-good-issue-url]: https://github.com/control-toolbox/Tutorials.jl/contribute -If you think you found a bug or if you have a feature request / suggestion, feel free to open an [issue][issue-url]. +If you think you found a bug or if you have a feature request / suggestion, feel free to open an [issue][issue-url]. Before opening a pull request, please start an issue or a discussion on the topic. -Contributions are welcomed, check out [how to contribute to a Github project](https://docs.github.com/en/get-started/exploring-projects-on-github/contributing-to-a-project). -If it is your first contribution, you can also check [this first contribution tutorial](https://github.com/firstcontributions/first-contributions). -You can find first good issues (if any 🙂) [here][first-good-issue-url]. You may find other packages to contribute to at the [control-toolbox organization](https://github.com/control-toolbox). +Contributions are welcomed, check out [how to contribute to a Github project](https://docs.github.com/en/get-started/exploring-projects-on-github/contributing-to-a-project). If it is your first contribution, you can also check [this first contribution tutorial](https://github.com/firstcontributions/first-contributions). You can find first good issues (if any 🙂) [here][first-good-issue-url]. You may find other packages to contribute to at the [control-toolbox organization](https://github.com/control-toolbox). If you want to ask a question, feel free to start a discussion [here](https://github.com/orgs/control-toolbox/discussions). This forum is for general discussion about this repository and the [control-toolbox organization](https://github.com/control-toolbox).