From 9fe2085887b45b644218ba4db77cc796dd772102 Mon Sep 17 00:00:00 2001
From: Mathieu Blondel <mblondel@google.com>
Date: Fri, 9 Feb 2024 12:07:20 +0000
Subject: [PATCH] Add development information in README.

---
 README.md | 31 +++++++++++++++++++++++++++++++
 1 file changed, 31 insertions(+)

diff --git a/README.md b/README.md
index 24d42f02..02ea9a9a 100644
--- a/README.md
+++ b/README.md
@@ -79,6 +79,37 @@ params = optax.apply_updates(params, updates)
 
 You can continue the quick start in [the Optax quickstart notebook.](https://github.com/google-deepmind/optax/blob/main/examples/quick_start.ipynb)
 
+## Development
+
+We welcome new contributors.
+
+### Source code
+
+You can check the latest sources with the following command.
+
+```sh
+git clone https://github.com/google-deepmind/optax.git
+```
+### Testing
+
+To run the tests, please execute the following script.
+
+```sh
+sh ./test.sh
+```
+
+### Documentation
+
+To build the documentation, first ensure that all the dependencies are installed.
+```sh
+pip install -e ".[docs]"
+```
+Then, execute the following.
+```sh
+cd docs/
+make html
+```
+
 ## Citing Optax
 
 This repository is part of the DeepMind JAX Ecosystem, to cite Optax