Skip to content
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.

Sign up for GitHub

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

Update README.rst #301

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Update README.rst #301

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ebab638
Update README.rst
gdgellatly Aug 1, 2022
40ff3fa
Update README.rst
gdgellatly Aug 1, 2022
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
18 changes: 13 additions & 5 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,24 +13,32 @@
.. image:: https://img.shields.io/pypi/v/openupgradelib.svg
:target: https://pypi.python.org/pypi/openupgradelib
:alt: Pypi Package

.. image:: https://img.shields.io/badge/License-AGPL%20v3-blue.svg
:target: https://www.gnu.org/licenses/agpl-3.0
:alt: License: AGPL v3
Copy link
Contributor

@MiquelRForgeFlow MiquelRForgeFlow Aug 1, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
.. image:: https://img.shields.io/badge/License-AGPL%20v3-blue.svg
:target: https://www.gnu.org/licenses/agpl-3.0
:alt: License: AGPL v3
.. image:: https://img.shields.io/badge/license-AGPL--3-blue.png
:target: https://www.gnu.org/licenses/agpl-3.0
:alt: License: AGPL-3

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lol, I literally cut and paste that from a recommended gist - no problems.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think I should revert the image, that png is dog ugly compared to the nice clean svg. Is there any reason we want png specifically?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh, as you wish. Just FYI svg files are not rendered in apps, thus I always put .png in readme files by default.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good enough reason for me, although the other images are svg's, I'll leave it.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OCA/maintainer-tools@52f4136

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Look the date of such change... I think this must be re-evaluated.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Well in any case, this is not an app.

Should I maybe convert to Markdown too? RST was a bit funky to edit remembering the slight syntax differences.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, this is not an app. Let's put svg then!

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

And we need to review the criteria for the rest, as Odoo has evolved. First of all, we nee to know where the incompatibility was.


===============================
OpenUpgrade Library
===============================

A library with support functions to be called from Odoo migration scripts.
For information on how to develop and contribute

* Free software: AGPL-3 license
* Documentation: https://openupgradelib.readthedocs.org.
* Contributor Documentation: https://openupgradelib.readthedocs.org.

Install
-------

Always get the latest version through:
Always get the latest version through either pip or pip3:

pip/pip3 install --ignore-installed git+https://github.com/OCA/openupgradelib.git@master
``pip install --ignore-installed git+https://github.com/OCA/openupgradelib.git@master``

Features
--------

* TODO
The OpenUpgrade library contains all kinds of helper functions for wrting scripts to migrate between odoo versions, in OpenUpgrade itself or in the migration scripts of your own module (in either major or minor version upgrades). Once installed, it can be used in your scripts as

``from openupgradelib import openupgrade``

* Library Documentation: https://oca.github.io/OpenUpgrade/API.html