You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

83 lines
2.7 KiB

  1. ============
  2. Easy My Coop
  3. ============
  4. .. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
  5. !! This file is generated by oca-gen-addon-readme !!
  6. !! changes will be overwritten. !!
  7. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
  8. .. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
  9. :target: https://odoo-community.org/page/development-status
  10. :alt: Beta
  11. .. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png
  12. :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
  13. :alt: License: AGPL-3
  14. .. |badge3| image:: https://img.shields.io/badge/github-coopiteasy%2Fvertical--cooperative-lightgray.png?logo=github
  15. :target: https://github.com/coopiteasy/vertical-cooperative/tree/12.0/easy_my_coop
  16. :alt: coopiteasy/vertical-cooperative
  17. |badge1| |badge2| |badge3|
  18. This project aim to deal with modules related to cooperatives management. You'll find modules that:
  19. - Allow people to sign up as a member of the cooperative from website
  20. - Manage member's shares, loans and dividends
  21. - Manage cooperative membership
  22. Please don't hesitate to suggest one of your modules to this project.
  23. **Table of contents**
  24. .. contents::
  25. :local:
  26. Installation
  27. ============
  28. ## Deploying with pip
  29. We used [odoo setup tools](https://pypi.org/project/setuptools-odoo/#packaging-a-single-addon) to generate the pypi files from the odoo manifests. To deploy any packaged module, so that odoo can later install them,
  30. you can create a venv with this name (it's git-ignored)
  31. ```shell
  32. python -m venv venv
  33. ```
  34. And then pip-install them [from pypi](https://pypi.org/user/coopdevs/).
  35. ### Example
  36. For instance, for the addon `easy_my_coop_website_portal`
  37. ```shell
  38. pip install odoo12-addon-easy-my-coop-website-portal==12.0.1.0.0.99.dev9
  39. ```
  40. Beware that for word separation, pypi uses dashes `-` and odoo underscores `_`.
  41. Bug Tracker
  42. ===========
  43. Bugs are tracked on `GitHub Issues <https://github.com/coopiteasy/vertical-cooperative/issues>`_.
  44. In case of trouble, please check there if your issue has already been reported.
  45. If you spotted it first, help us smashing it by providing a detailed and welcomed
  46. `feedback <https://github.com/coopiteasy/vertical-cooperative/issues/new?body=module:%20easy_my_coop%0Aversion:%2012.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
  47. Do not contact contributors directly about support or help with technical issues.
  48. Credits
  49. =======
  50. Authors
  51. ~~~~~~~
  52. * Coop IT Easy SCRLfs
  53. Contributors
  54. ~~~~~~~~~~~~
  55. * Coop IT Easy SCRLfs
  56. Maintainers
  57. ~~~~~~~~~~~
  58. This module is part of the `coopiteasy/vertical-cooperative <https://github.com/coopiteasy/vertical-cooperative/tree/12.0/easy_my_coop>`_ project on GitHub.
  59. You are welcome to contribute.