diff --git a/README.md b/README.md
index 2c22193..b6a365c 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,7 @@
[](https://gitlab.com/odoo-openupgrade-wizard/odoo-openupgrade-wizard/-/pipelines)
[](https://gitlab.com/odoo-openupgrade-wizard/odoo-openupgrade-wizard/)
[](https://www.gnu.org/licenses/agpl-3.0)
+[](https://www.python.org/doc/versions/)
@@ -23,6 +24,22 @@ and provides helpers to run (and replay) migrations until it works.
* Refer to the ``ROADMAP.md`` file to see the current limitation, bugs, and task to do.
* See authors in the ``CONTRIBUTORS.md`` file.
+# Table of Contents
+
+* [Installation](#installation)
+* [Usage](#usage)
+ * [Command ``init``](#command-init)
+ * [Command ``pull-submodule``](#command-pull-submodule)
+ * [Command ``get-code``](#command-get-code)
+ * [Command ``docker-build``](#command-docker-build)
+ * [Command ``run`` (BETA)](#command-run)
+ * [Command ``install-from-csv``](#command-install-from-csv)
+ * [Command ``upgrade`` (BETA)](#command-upgrade)
+ * [Command ``generate-module-analysis`` (BETA)](#command-generate-module-analysis)
+ * [Command ``estimate-workload`` (BETA)](#command-estimate-workload)
+
+
+
# Installation
**Prerequites:**
@@ -41,6 +58,8 @@ To install it simply run :
(See alternative installation in ``DEVELOP.md`` file.)
+
+
# Usage
**Note:**
@@ -48,6 +67,8 @@ To install it simply run :
the term ``odoo-openupgrade-wizard`` can be replaced by ``oow``
in all the command lines below.
+
+
## Command: ``init``
```
@@ -146,6 +167,8 @@ extra repositories, or dependencies...
- In your repos.yml file, the odoo project should be in ``./src/odoo``
and the openupgrade project should be in ``./src/openupgrade/`` folder.
+
+
## Command: ``pull-submodule``
**Prerequites:** init
@@ -169,6 +192,8 @@ then run following command :
odoo-openupgrade-wizard pull-submodule
```
+
+
## Command: ``get-code``
**Prerequites:** init
@@ -195,7 +220,7 @@ if you want to update the code of some given versions, you can provide an extra
odoo-openupgrade-wizard get-code --versions 10.0,11.0
```
-
+
## Command: ``docker-build``
@@ -225,6 +250,7 @@ odoo-openupgrade-wizard-image---my-customer-10-12---10.0 latest 9d94dce2bd4
* This step could take a big while also !
+
## Command: ``run`` (BETA)
@@ -252,6 +278,7 @@ at your host, at the following url : http://localhost:9069
of the installation.
+
## Command: ``install-from-csv``
@@ -273,6 +300,7 @@ psql -c "copy (select name, shortdesc from ir_module_module where state = 'insta
```
+
## Command: ``upgrade`` (BETA)
@@ -300,6 +328,7 @@ For each step, it will :
* You can add ``--last-step=3`` to end at the third step.
+
## Command: ``generate-module-analysis`` (BETA)
@@ -318,6 +347,7 @@ in OpenUpgrade project.
You can also use this fonction to analyze differences for custom / OCA modules
between several versions, in case of refactoring.
+
## Command: ``estimate-workload``