Skip to content

Release 2025 - README #32

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 1 addition & 5 deletions AUTHORS.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,18 +5,14 @@ Credits
Development Lead
----------------

.. {# pkglts, doc.authors

* Baptiste Brument, <[email protected]>
* Christophe Pradal, <[email protected]>

.. #}

Contributors
------------

.. {# pkglts, doc.contributors
* Aurelien Besnier, <[email protected]

* pradal <[email protected]>

.. #}
27 changes: 27 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# oawidgets

![Documentation status](https://readthedocs.org/projects/oawidgets/badge/?version=latest)
[![Version](https://anaconda.org/openalea3/oawidgets/badges/version.svg)](https://anaconda.org/openalea3/oawidgets)
[![Downloads](https://anaconda.org/openalea3/oawidgets/badges/downloads.svg)](https://anaconda.org/openalea3/oawidgets)


## Installation


Install the following packages

```bash
mamba install -c openalea3 -c conda-forge oawidgets
```

If you want to use the lpy extension, install also lpy

```bash
mamba install -c openalea3 -c conda-forge oawidgets openalea.lpy
```

## Contributors

<a href="https://github.com/openalea/oawidgets/graphs/contributors">
<img src="https://contrib.rocks/image?repo=openalea/oawidgets" />
</a>
29 changes: 0 additions & 29 deletions README.rst

This file was deleted.

5 changes: 2 additions & 3 deletions doc/usage.rst → doc/gallery.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
=====
Usage
=====
Gallery
=======

.. nbgallery::

Expand Down
19 changes: 2 additions & 17 deletions doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,9 @@ Welcome to oawidgets's documentation!

Home <self>
readme
usage
gallery
authors
license



Expand All @@ -25,22 +26,6 @@ Welcome to oawidgets's documentation!
More documentation on OpenAlea can be found on the
`OpenAlea <https://openalea.readthedocs.io>`__ website.

Authors
=======

.. include:: ../AUTHORS.rst

License
=======

oawidgets is released under a Cecill-C License.

.. note:: `Cecill-C <http://www.cecill.info/licences/Licence_CeCILL-C_V1-en.html>`_
license is a LGPL compatible license.

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
7 changes: 7 additions & 0 deletions doc/license.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
License
=======

oawidgets is released under a Cecill-C License.

.. note:: `Cecill-C <http://www.cecill.info/licences/Licence_CeCILL-C_V1-en.html>`_
license is a LGPL compatible license.
2 changes: 2 additions & 0 deletions doc/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
```{include} ../../README.md
```
5 changes: 0 additions & 5 deletions doc/readme.rst

This file was deleted.

Loading