更新README

Signed-off-by: Kenneth Lee <[email protected]>
Kenneth-Lee · Oct 2, 2023 · ac7f4f8 · ac7f4f8
1 parent 1afed0d
commit ac7f4f8
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 12 deletions.
diff --git a/README b/README
diff --git a/README.md b/README.md
@@ -0,0 +1,21 @@
+# 《道德经》直译
+
+这是一个基于Sphinx的工程，用rst格式写了一本翻译道德经的书，书的入口在
+source/index.rst中。
+
+rst是一种markdown格式，本身完全是文本，可以直接阅读，但在通过sphinx工具生成正式
+文档前，很多公式，链接都是不能用的，如果您需要更好的阅读体验，请考虑通过如下自
+动生成网站访问：
+[道德经直译@readthedocs](https://daodejing-translation.readthedocs.io/zh/latest/index.html)
+
+或者自行下载编译。
+
+本文使用了两个git托管服务：
+
+* [道德经直译@gitee](https://gitee.com/Kenneth-Lee-2012/daodejing_translation)
+
+* [道德经直译@github](https://github.com/Kenneth-Lee-2012/daodejing_translation)
+
+其中gitee使用了一个非常粗暴的敏感词过滤系统，所以经常把一些内容标记为“敏感内容”，
+其实这里基本上都是直接翻译，没有什么敏感内容，所以，因此看不到的读者，请考虑用
+前面提到的readthedocs访问，或者直接用git把工程下载下来自行编译。