From 17ef6fe4a9c128d16d077c4618a0f6913258d155 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 1/2] 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 From 170da98d2eefdfbde4a2089f64c9554f9120f557 Mon Sep 17 00:00:00 2001 From: sunshinesmilelk Date: Mon, 18 Nov 2024 17:31:42 +0800 Subject: [PATCH 2/2] docs: add image about libro launch --- README.md | 3 +-- README_zh.md | 8 ++++++++ 2 files changed, 9 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 26a0d36a..3b930ed0 100644 --- a/README.md +++ b/README.md @@ -63,8 +63,7 @@ Enter command `libro` in the terminal to start the web server, then the browser ```bash libro ``` -TODO: **add scrren capture with the launched APP** - +![image](https://raw.githubusercontent.com/wiki/difizen/libro/assets/libro_launch.png) For more details, please refer to [quick start](./apps/docs/docs/quickstart/index.md)。 diff --git a/README_zh.md b/README_zh.md index a018fa4c..64501ff6 100644 --- a/README_zh.md +++ b/README_zh.md @@ -50,6 +50,7 @@ ## 快速开始 +### 安装 ```bash pip install libro ``` @@ -59,6 +60,13 @@ pip install libro 详情请阅读[快速开始](./apps/docs/docs/quickstart/index.md)。 +### 启动 +在终端中输入命令 `libro` 启动 Web 服务器，随后浏览器会自动打开 Libro。 + +```bash +libro +``` +![image](https://raw.githubusercontent.com/wiki/difizen/libro/assets/libro_launch.png) ## 新特性