[UPD] doc: better release information, readme and development

This commit is contained in:
Mathieu Benoit 2022-01-24 14:03:38 -05:00
parent 83b8792227
commit ad5b21cbca
4 changed files with 33 additions and 0 deletions

View file

@ -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

View file

@ -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 .

View file

@ -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

View file

@ -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