diff --git a/README.md b/README.md index c7afc665c..9c5497256 100755 --- a/README.md +++ b/README.md @@ -1,32 +1,15 @@
- - - - -

Bench

-
+ +

Bench

Bench is a command-line utility that helps you to install, update, and manage multiple sites for Frappe/ERPNext applications on [*nix systems](https://en.wikipedia.org/wiki/Unix-like) for development and production. -
- - - - - - - - PyPI version - - - - - - - - - - +[![Python version](https://img.shields.io/badge/python-%3E=_3.10-green.svg)](https://www.python.org/downloads/) +[![PyPI Version](https://badge.fury.io/py/frappe-bench.svg)](https://pypi.org/project/frappe-bench) +![Platform Compatibility](https://img.shields.io/badge/platform-linux%20%7C%20osx-blue) +[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Ffrappe%2Fbench.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2Ffrappe%2Fbench?ref=badge_shield) +[![License: GPLv3](https://img.shields.io/badge/License-GPLv3-blue.svg)](#LICENSE) +
## Table of Contents @@ -59,7 +42,7 @@ The setup for each of these installations can be achieved in multiple ways: We recommend using Docker Installation to setup a Production Environment. For Development, you may choose either of the two methods to setup an instance. -Otherwise, if you are looking to evaluate Frappe apps without hassle of hosting, you can try them [on frappecloud.com](https://frappecloud.com/). +Otherwise, if you are looking to evaluate Frappe apps without the hassle of managing hosting yourself, you can try them on [Frappe Cloud](https://frappecloud.com/). ### Containerized Installation @@ -69,8 +52,7 @@ A Frappe/ERPNext instance can be setup and replicated easily using [Docker](http To setup either of the environments, you will need to clone the official docker repository: ```sh -$ git clone https://github.com/frappe/frappe_docker.git -$ cd frappe_docker +git clone https://github.com/frappe/frappe_docker.git ``` A quick setup guide for both the environments can be found below. For more details, check out the [Frappe/ERPNext Docker Repository](https://github.com/frappe/frappe_docker). @@ -86,8 +68,8 @@ This script uses Docker with the [Frappe/ERPNext Docker Repository](https://gith Download the Easy Install script and execute it: ```sh -$ wget https://raw.githubusercontent.com/frappe/bench/develop/easy-install.py -$ python3 easy-install.py deploy --email=user@domain.tld --sitename=subdomain.domain.tld --app=erpnext +wget https://raw.githubusercontent.com/frappe/bench/develop/easy-install.py +python3 easy-install.py deploy --email=user@domain.tld --sitename=subdomain.domain.tld --app=erpnext ``` This script will install docker on your system and will fetch the required containers, setup bench and a default ERPNext instance. @@ -255,11 +237,11 @@ In case the setup fails, the log file is saved under `$HOME/easy-install.log`. Y Some might want to manually setup a bench instance locally for development. To quickly get started on installing bench the hard way, you can follow the guide on [Installing Bench and the Frappe Framework](https://frappe.io/docs/user/en/installation). -You'll have to set up the system dependencies required for setting up a Frappe Environment. Checkout [docs/installation](https://github.com/frappe/bench/blob/develop/docs/installation.md) for more information on this. If you've already set up, install bench via pip: +You'll have to set up the system dependencies required for setting up a Frappe Environment. Checkout [docs/installation](https://docs.frappe.io/framework/user/en/tutorial/install-and-setup-bench) for more information on this. If you've already set up, install bench via pip: ```sh -$ pip install frappe-bench +pip install frappe-bench ``` @@ -348,27 +330,32 @@ To contribute and develop on the bench CLI tool, clone this repo and create an e This is not the recommended mode of installation for production. Instead, install the package from PyPI with: `pip install frappe-bench` +### Clone and install ```sh -$ git clone https://github.com/frappe/bench ~/bench-repo -$ pip3 install -e ~/bench-repo -$ bench src -/Users/frappe/bench-repo +git clone https://github.com/frappe/bench ~/bench-repo +pip install -e ~/bench-repo ``` -To clear up the editable install and switch to a stable version of bench, uninstall via pip and delete the corresponding egg file from the python path. +```shell +bench src +``` +This should display $HOME/bench-repo +### To clear up the editable install and delete the corresponding egg file from the python path: ```sh # Delete bench installed in editable install -$ rm -r $(find ~ -name '*.egg-info') -$ pip3 uninstall frappe-bench +rm -r $(find ~ -name '*.egg-info') +pip uninstall frappe-bench +``` -# Install latest released version of bench -$ pip3 install -U frappe-bench +### Then you can install the latest from PyPI +```sh +pip install -U frappe-bench ``` -To confirm the switch, check the output of `bench src`. It should change from something like `$HOME/bench-repo` to `/usr/local/lib/python3.6/dist-packages` and stop the editable install warnings from getting triggered at every command. +To confirm the switch, check the output of `bench src`. It should change from something like `$HOME/bench-repo` to `/usr/local/lib/python3.12/dist-packages` and stop the editable install warnings from getting triggered at every command. ## Releases diff --git a/resources/logo.png b/resources/logo.png new file mode 100644 index 000000000..578bd6f50 Binary files /dev/null and b/resources/logo.png differ