diff --git a/README.md b/README.md index d4e5f2e..c6246a0 100644 --- a/README.md +++ b/README.md @@ -1,33 +1,53 @@ # ERPLibre documentation + Select a guide to install your environment. ## Easy way to run locally + Into Ubuntu, minimal dependency: + ```bash -sudo apt install make git +sudo apt install make git curl ``` + +Into Ubuntu, developper dependency: + +```bash +sudo apt install make build-essential libssl-dev zlib1g-dev libreadline-dev libsqlite3-dev curl llvm libncurses5-dev libncursesw5-dev xz-utils tk-dev liblzma-dev libbz2-dev libldap2-dev libsasl2-dev +``` + Clone the project: + ```bash git clone https://github.com/ERPLibre/ERPLibre.git cd ERPLibre ``` + Support Ubuntu 18.04, 20.04 and OSX. The installation duration is more than 30 minutes. + ```bash make install ``` + Update your configuration if you need to run from another interface than 127.0.0.1, file `config.conf` + ``` xmlrpc_interface = 0.0.0.0 ``` + Ready to execute: + ```bash make run ``` ## Easy way to run docker -First, install dependencies to run docker, check script `./script/install/install_ubuntu_docker.sh`. You need docker and docker-compose. + +First, install dependencies to run docker, check script `./script/install/install_ubuntu_docker.sh`. You need docker and +docker-compose. The docker volume is bound to the directory name, therefore create a unique directory name and run: + ```bash wget https://raw.githubusercontent.com/ERPLibre/ERPLibre/v1.5.0/docker-compose.yml docker compose up -d @@ -36,22 +56,29 @@ docker compose up -d For more information, read [Docker guide](./docker/README.md). ## Discover guide + [Guide to run ERPLibre in discover to learn it](./doc/DISCOVER.md). ## Production guide + [Guide to run ERPLibre in production server](./doc/PRODUCTION.md). ## Development guide + [Guide to run ERPLibre in development environment](./doc/DEVELOPMENT.md). # Execution + [Guide to run ERPLibre with different case](./doc/RUN.md). # git-repo + To change repository like addons, see [GIT_REPO.md](doc/GIT_REPO.md) # Test + Execute ERPLibre test with his code generator. + ```bash time make test_full_fast ```