Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: full-fill the "Quick Start" section #316

Merged
merged 2 commits into from
Nov 18, 2024
Merged

docs: full-fill the "Quick Start" section #316

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
17ef6fe
docs: full-fill the "quick start" section
bubkoo Nov 18, 2024
170da98
docs: add image about libro launch
sunshinesmilelk Nov 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,12 +51,20 @@ 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
```
![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)。

## New Features
Expand Down
8 changes: 8 additions & 0 deletions README_zh.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@

## 快速开始

### 安装
```bash
pip install libro
```
Expand All @@ -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)

## 新特性

Expand Down
Loading