diff --git a/README.md b/README.md index 7517f5d..4ac9a2d 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,10 @@ Select a guide to install your environment. ## Easy way to run locally +Into Ubuntu, minimal dependency: +```bash +sudo apt install make git +``` Clone the project: ```bash git clone https://github.com/ERPLibre/ERPLibre.git diff --git a/doc/DEVELOPMENT.md b/doc/DEVELOPMENT.md index af10163..6fdb92f 100644 --- a/doc/DEVELOPMENT.md +++ b/doc/DEVELOPMENT.md @@ -197,6 +197,14 @@ source ./.venv/bin/activate python odoo/odoo-bin scaffold MODULE_NAME addons/REPO_NAME/ ``` +## Use Code generator + +Read CODE_GENERATOR.md. + +# Version + +Read GIT_REPO.md to understand how changer version. + ## Python version Your actual version is in file .python-version. Use script `./script/version/change_python_version.sh 3.7.12` to change to version 3.7.12 . diff --git a/doc/FAQ.md b/doc/FAQ.md index 285ebd6..fc8c90e 100644 --- a/doc/FAQ.md +++ b/doc/FAQ.md @@ -1,5 +1,19 @@ # FAQ +## Scripting + +### Search all duplicate file recursively in given directory + +```bash +find . -type f -printf '%p/ %f\n' | sort -k2 | uniq -f1 --all-repeated=separate +``` + +### Search all duplicate directory recursively in given directory + +```bash +find . -type d -printf '%p/ %f\n' | sort -k2 | uniq -f1 --all-repeated=separate +``` + ## Networking Show all open port diff --git a/doc/RELEASE.md b/doc/RELEASE.md index 327923c..89f4436 100644 --- a/doc/RELEASE.md +++ b/doc/RELEASE.md @@ -45,6 +45,7 @@ make format To generate database images in directory `./image_db`, run: ```bash +make config_gen_all make image_db_create_all ``` @@ -73,6 +74,8 @@ grep --color=always --exclude-dir={.repo,.venv,.git} --exclude="*.svg" -nri v1.2 Replace if need it to new version. +Update file `./pyproject.toml` in [tool.poetry], line `version =`. + ### Test production Ubuntu environment Follow instructions in [PRODUCTION.md](./PRODUCTION.md). @@ -185,6 +188,10 @@ List your docker version You need to push your docker image and update your tag, like 1.0.1: > docker push technolibre/erplibre:VERSION +## Do a release on github + +Visit `https://github.com/ERPLibre/ERPLibre/releases/new` and create a release named `v#.#.#` and copy information from CHANGELOG.md. + # TIPS ## Compare repo differences with another ERPLibre project