akretion · sebastienbeau · Oct 9, 2022
diff --git a/MANIFEST.in b/MANIFEST.in
@@ -0,0 +1 @@
+include requirements.txt
diff --git a/README.md b/README.md
diff --git a/README.rst b/README.rst
@@ -0,0 +1,60 @@
+Ak
+====
+
+Installation:
+
+We deeply recommand you to use pipx for installing python cli
+
+Install with pipx
+
+.. code-block:: shell
+
+    pipx install git+https://github.com/akretion/ak --force --include-deps
+
+If you don't want to use pipx, y
10000
ou can still use something like this:
+
+.. code-block:: shell
+
+    python3 -m pip install git+https://github.com/akretion/ak --user
+
+Install for dev purpose
+
+.. code-block:: shell
+
+    git clone https://github.com/akretion/ak
+    cd ak
+    pipx install -e --spec . ak --force --include-deps
+
+Usage
+
+.. code-block:: shell
+
+    Usage:
+        ak [SWITCHES] [SUBCOMMAND [SWITCHES]] args...
+
+    Meta-switches:
+        -h, --help         Prints this help message and quits
+        --help-all         Prints help messages of all sub-commands and quits
+        -v, --version      Prints the program's version and quits
+
+    Switches:
+        --verbose          Verbose mode
+
+    Sub-commands:
+        build              Build dependencies for odoo; see 'ak build --help' for more info
+        db                 Read db credentials from ERP_CFG.  Add -d flag to the current command to override PGDATABASE
+                           Add self.db  Usage: Heritate from this class and call determine_db()  class
+                           AkSomething(cli.Application, DbTools): def main(self): self.set_db() # your stuff here print
+                           self.db; see 'ak db --help' for more info
+        diff               Diff tools. Scan all Odoo module repositories, based on addons_path in the erp config file. For
+                           each repository, launch a diff command. For the time being, only git is implemented.; see 'ak
+                           diff --help' for more info
+        freeze             Freeze dependencies for odoo in config file formated for git aggregator; see 'ak freeze --help'
+                           for more info
+        migrate            Extraction repository/branch data from buildout to build spec file; see 'ak migrate --help' for
+                           more info
+        module             Testing Module; see 'ak module --help' for more info
+        project            Project task related; see 'ak project --help' for more info
+        suggest            Display available modules which are not in modules list of your SPEC_YAML. display i.e.
+                           INFO:ak.ak_suggest:   1 modules in branch https://github.com/oca/.../tree/12.0 ['base_...']  By
+                           using `include` option, you may filter the output ; see 'ak suggest --help' for more info
diff --git a/requirement.txt → requirements.txt b/requirement.txt → requirements.txt
diff --git a/setup.py b/setup.py
@@ -25,9 +25,10 @@ def find_version(*file_paths):
     url='https://github.com/akretion/ak',
     description='simple cli for Odoo',
     license="AGPLv3+",
-    long_description=open('README.md').read(),
+    long_description=open('README.rst').read(),
+    long_description_content_type='text/x-rst',
     install_requires=[
-        r.strip() for r in open('requirement.txt').read().splitlines() ],
+        r.strip() for r in open('requirements.txt').read().splitlines() ],
     entry_points="""
     [console_scripts]
     ak=ak.main:main