From cd252654642e5e5158f1d9253b23bbf9668b55cb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E5=B4=96?= Date: Mon, 18 Nov 2024 15:34:01 +0800 Subject: [PATCH] docs: full-fill the "quick start" section The quick start section should as least include: 1. how to install libro 2. how to start libro app 3. embed a screen-capture with the defaut appearance after launched --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.md b/README.md index e2883c41..26a0d36a 100644 --- a/README.md +++ b/README.md @@ -51,12 +51,21 @@ Language: English | [简体中文](./README_zh.md) ## Quick Start +### Install ```bash pip install libro ``` > [!NOTE] > The Python version used is 3.10-3.12. Higher versions of Python may encounter issues with unsupported dependencies. +### Run +Enter command `libro` in the terminal to start the web server, then the browser will automatically launch Libro. +```bash +libro +``` +TODO: **add scrren capture with the launched APP** + + For more details, please refer to [quick start](./apps/docs/docs/quickstart/index.md)。 ## New Features