Skip to content

Commit fcb17b1

Browse files
committed
update README.md
1 parent 023eb27 commit fcb17b1

File tree

2 files changed

+20
-7
lines changed

2 files changed

+20
-7
lines changed

README.md

+20-4
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,26 @@
1-
# Shiu
1+
# Shiu #
22

3-
Shiu (/ʃʐy/),中文音标 (shi rü)),是一款基于 WebApp 的阅读应用,愿景是带来阅读新体验。
3+
Shiu (/ʃʐy/),中文音标 (shi rü)),是一款基于 WebApp 的阅读应用,
4+
愿景是带来阅读新体验。
45

5-
请访问 http://shiu.log4d.com
6+
## 使用 ##
67

7-
//TODO
8+
1. 使用 iOS / Android 访问 [http://shiu.log4d.com](http://shiu.log4d.com)
9+
1. 选择需要下载的小说
10+
1. Shiu 会自动开始下载
11+
1. 下载完成之后,iOS 「添加至主屏幕」,Android 会自动刷新开始进入阅读模式。
12+
13+
## 制作书籍 ##
14+
15+
使用 `manager.py` 可以自己制作书籍,过程如下:
16+
17+
1. 新建目录比如 `santi2`
18+
1. 准备书籍的 txt 格式文件按章节从 `01` 开始命名,并放置在 `santi2/src` 目录中
19+
1. 准备书籍信息 `info.ini` 内容可以参考
20+
[santi1/src/info.ini](https://github.com/alswl/shiu/blob/master/santi1/src/info.ini)
21+
1. 运行命令 `manager.py --parse-dir /the/path/of/book` 就可以生成书籍数据
22+
1. 修改 `index.html` 将书籍链接加到对应地方
23+
1. 运行命令 `manager.py --serve` 即可在本地启动服务
824

925
更多开发信息可以查看 [开发记录](https://github.com/alswl/shiu/blob/master/shiu_dev.asciidoc)
1026

santi1/src/info.ini~

-3
This file was deleted.

0 commit comments

Comments
 (0)