[DOC] Add Table of content in Readme.md file

This commit is contained in:
Sylvain LE GAL 2023-04-26 14:42:48 +02:00
parent a161e4d02f
commit ad0f51267c

View File

@ -23,6 +23,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. * Refer to the ``ROADMAP.md`` file to see the current limitation, bugs, and task to do.
* See authors in the ``CONTRIBUTORS.md`` file. * 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)
<a name="installation"/>
# Installation # Installation
**Prerequites:** **Prerequites:**
@ -41,6 +57,8 @@ To install it simply run :
(See alternative installation in ``DEVELOP.md`` file.) (See alternative installation in ``DEVELOP.md`` file.)
<a name="usage"/>
# Usage # Usage
**Note:** **Note:**
@ -48,6 +66,8 @@ To install it simply run :
the term ``odoo-openupgrade-wizard`` can be replaced by ``oow`` the term ``odoo-openupgrade-wizard`` can be replaced by ``oow``
in all the command lines below. in all the command lines below.
<a name="command-init"/>
## Command: ``init`` ## Command: ``init``
``` ```
@ -146,6 +166,8 @@ extra repositories, or dependencies...
- In your repos.yml file, the odoo project should be in ``./src/odoo`` - In your repos.yml file, the odoo project should be in ``./src/odoo``
and the openupgrade project should be in ``./src/openupgrade/`` folder. and the openupgrade project should be in ``./src/openupgrade/`` folder.
<a name="command-pull-submodule"/>
## Command: ``pull-submodule`` ## Command: ``pull-submodule``
**Prerequites:** init **Prerequites:** init
@ -169,6 +191,8 @@ then run following command :
odoo-openupgrade-wizard pull-submodule odoo-openupgrade-wizard pull-submodule
``` ```
<a name="command-get-code"/>
## Command: ``get-code`` ## Command: ``get-code``
**Prerequites:** init **Prerequites:** init
@ -195,7 +219,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 odoo-openupgrade-wizard get-code --versions 10.0,11.0
``` ```
<a name="command-docker-build"/>
## Command: ``docker-build`` ## Command: ``docker-build``
@ -225,6 +249,7 @@ odoo-openupgrade-wizard-image---my-customer-10-12---10.0 latest 9d94dce2bd4
* This step could take a big while also ! * This step could take a big while also !
<a name="command-run"/>
## Command: ``run`` (BETA) ## Command: ``run`` (BETA)
@ -252,6 +277,7 @@ at your host, at the following url : http://localhost:9069
of the installation. of the installation.
<a name="command-install-from-csv"/>
## Command: ``install-from-csv`` ## Command: ``install-from-csv``
@ -273,6 +299,7 @@ psql -c "copy (select name, shortdesc from ir_module_module where state = 'insta
``` ```
<a name="command-upgrade"/>
## Command: ``upgrade`` (BETA) ## Command: ``upgrade`` (BETA)
@ -300,6 +327,7 @@ For each step, it will :
* You can add ``--last-step=3`` to end at the third step. * You can add ``--last-step=3`` to end at the third step.
<a name="command-generate-module-analysis"/>
## Command: ``generate-module-analysis`` (BETA) ## Command: ``generate-module-analysis`` (BETA)
@ -318,6 +346,7 @@ in OpenUpgrade project.
You can also use this fonction to analyze differences for custom / OCA modules You can also use this fonction to analyze differences for custom / OCA modules
between several versions, in case of refactoring. between several versions, in case of refactoring.
<a name="command-estimate-workload"/>
## Command: ``estimate-workload`` ## Command: ``estimate-workload``