diff --git a/base_fontawesome/README.rst b/base_fontawesome/README.rst index 44b2dd14e..84e638a70 100644 --- a/base_fontawesome/README.rst +++ b/base_fontawesome/README.rst @@ -1,61 +1,91 @@ -.. image:: https://img.shields.io/badge/licence-lgpl--3-blue.svg - :target: http://www.gnu.org/licenses/LGPL-3.0-standalone.html - :alt: License: LGPL-3 - ================ Base Fontawesome ================ +.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! This file is generated by oca-gen-addon-readme !! + !! changes will be overwritten. !! + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + +.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png + :target: https://odoo-community.org/page/development-status + :alt: Beta +.. |badge2| image:: https://img.shields.io/badge/licence-LGPL--3-blue.png + :target: http://www.gnu.org/licenses/lgpl-3.0-standalone.html + :alt: License: LGPL-3 +.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fserver--tools-lightgray.png?logo=github + :target: https://github.com/OCA/server-tools/tree/11.0/base_fontawesome + :alt: OCA/server-tools +.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png + :target: https://translation.odoo-community.org/projects/server-tools-11-0/server-tools-11-0-base_fontawesome + :alt: Translate me on Weblate +.. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png + :target: https://runbot.odoo-community.org/runbot/149/11.0 + :alt: Try me on Runbot + +|badge1| |badge2| |badge3| |badge4| |badge5| + Provide up to date `Fontawesome `_ resources. -Current version: 4.7.0 (the version of this module matches it). +Current version: 5.3.1 (the version of this module matches it). -Installation and usage -====================== +**Table of contents** -Install it as any other Odoo module. You'll get the standard Odoo Fontawesome assets -replaced with the updated version of this module. +.. contents:: + :local: -Then in your theme styles (or any other CSS file) you can benefit from latest FA features. +Usage +===== +Now, all free icons from `Font Awesome `_ +can be used on odoo. It also adds three options in order to add the icons: +* solid_icon +* regular_icon +* brand_icon +The usage depends on the configuration of the icon. -Roadmap -======= - -As of today Odoo v11 (master) is already shipping the latest version of FA. -In case they keep it up to date we can skip the migration of this module to v11. -Otherwise we can keep it and upgrade it to have always the most recent version. +For example, brand_icon is necessary if we are using an icon of a brand:: +