From 73ddb8084f498f3641a474d4569ab81465863184 Mon Sep 17 00:00:00 2001 From: Boming Zhang Date: Fri, 18 Oct 2024 01:39:20 -0400 Subject: [PATCH] docs: install from gitea repo --- README.md | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 380eb0c..6d8ee42 100644 --- a/README.md +++ b/README.md @@ -4,12 +4,13 @@ ### For users -1. Install [Python>=3.6](https://www.python.org/) and [pip](https://pip.pypa.io/). -2. Install the project by `pip install .` +1. Install [Python>=3.6](https://www.python.org/) and [pip](https://pip.pypa.io/) +2. Install the project by `pip install git+ssh://git@focs.ji.sjtu.edu.cn:2222/JOJ/JOJ3-config-generator.git` 3. Run it by `joj3-config-generator --help` ### For developers -1. Install [Python>=3.6](https://www.python.org/) and [PDM](https://pdm-project.org/). -2. Install deps by `pdm install && pdm run pre-commit install`. -3. Run the cli app by `pdm run app --help` +1. Clone this repo by `ssh://git@focs.ji.sjtu.edu.cn:2222/JOJ/JOJ3-config-generator.git` +2. Install [Python>=3.6](https://www.python.org/) and [PDM](https://pdm-project.org/) +3. Install deps by `pdm install && pdm run pre-commit install`. +4. Run the cli app by `pdm run app --help`