From ad0f51267c9ad294eac6c6210ed1f16f908f59d6 Mon Sep 17 00:00:00 2001 From: Sylvain LE GAL Date: Wed, 26 Apr 2023 14:42:48 +0200 Subject: [PATCH 1/2] [DOC] Add Table of content in Readme.md file --- README.md | 31 ++++++++++++++++++++++++++++++- 1 file changed, 30 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 2c22193..ba95cf6 100644 --- a/README.md +++ b/README.md @@ -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. * 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 +57,8 @@ To install it simply run : (See alternative installation in ``DEVELOP.md`` file.) + + # Usage **Note:** @@ -48,6 +66,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 +166,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 +191,8 @@ then run following command : odoo-openupgrade-wizard pull-submodule ``` + + ## Command: ``get-code`` **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 ``` - + ## 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 ! + ## Command: ``run`` (BETA) @@ -252,6 +277,7 @@ at your host, at the following url : http://localhost:9069 of the installation. + ## Command: ``install-from-csv`` @@ -273,6 +299,7 @@ psql -c "copy (select name, shortdesc from ir_module_module where state = 'insta ``` + ## Command: ``upgrade`` (BETA) @@ -300,6 +327,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 +346,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`` From 17ea6aa9c28c5262703e356e79d8fb13891212a0 Mon Sep 17 00:00:00 2001 From: Sylvain LE GAL Date: Wed, 26 Apr 2023 19:41:12 +0200 Subject: [PATCH 2/2] [DOC] Add badges --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index ba95cf6..b6a365c 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,7 @@ [![Gitlab CI](https://gitlab.com/odoo-openupgrade-wizard/odoo-openupgrade-wizard/badges/main/pipeline.svg)](https://gitlab.com/odoo-openupgrade-wizard/odoo-openupgrade-wizard/-/pipelines) [![codecov](https://gitlab.com/odoo-openupgrade-wizard/odoo-openupgrade-wizard/badges/main/coverage.svg)](https://gitlab.com/odoo-openupgrade-wizard/odoo-openupgrade-wizard/) [![License: AGPL v3](https://img.shields.io/badge/License-AGPL_v3-blue.svg)](https://www.gnu.org/licenses/agpl-3.0) +[![Python](https://img.shields.io/badge/python-3.6|3.7|3.8|3.9-blue.svg)](https://www.python.org/doc/versions/)