Skip to content

Commit

Permalink
docs: full-fill the "quick start" section
Browse files Browse the repository at this point in the history
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
  • Loading branch information
bubkoo authored and sunshinesmilelk committed Nov 18, 2024
1 parent 5beb2b3 commit cd25265
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit cd25265

Please sign in to comment.