From 95710f4bce896e183f37e7221f2c983462ee7beb Mon Sep 17 00:00:00 2001 From: zengjq Date: Tue, 29 Jun 2021 14:57:57 +0800 Subject: [PATCH] update README --- README.md | 6 ++---- README_CN.md | 5 ++--- 2 files changed, 4 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index f25b25f..a26f11b 100644 --- a/README.md +++ b/README.md @@ -11,13 +11,11 @@ If you have old data, PLEASE BACK UP YOUR DATA BEFORE USE. # How to use - -## Just run it 1. Download from the latest release that suit your computer system. 2. Unzip and execute(trilium for Linux, trilium.sh for Linux sever, trilium.exe for Windows, trilium.app for macOS). 3. Enjoy :) -## How to run server with docker +# How to run server with docker For Trilium Notes server, you can run it with docker simply by executing: ``` docker-compose up -d @@ -25,7 +23,7 @@ docker-compose up -d It will download the Chinese version of Trilium I built on [Docker Hub](https://hub.docker.com/repository/docker/nriver/trilium-cn). -Open http://127.0.0.1:8080 in your browser. +Open http://127.0.0.1:8080 in your browser to access the server page. # How to translate If you would like to check the code (my codes comes with Chinese and English comments, check it) and compile it by yourself. Here is some information may be useful. diff --git a/README_CN.md b/README_CN.md index 8780d2e..5f7becd 100644 --- a/README_CN.md +++ b/README_CN.md @@ -6,12 +6,11 @@ 如果你是老用户, 使用前最好备份数据以防万一. # 使用方法 -## 直接运行 1. Release里下载对应客户端 2. 解压运行(Linux桌面运行trilium, Linux服务端运行trilium.sh, Windows 运行trilium.exe, macOS 运行trilium.app, ). 3. 玩去吧 :) -## 在Docker里运行服务端 +# 在Docker里运行服务端 Trilium Notes的服务端可以用我构建好的docker镜像运行. ``` docker-compose up -d @@ -19,7 +18,7 @@ docker-compose up -d 它会从[Docker Hub](https://hub.docker.com/repository/docker/nriver/trilium-cn)直接拉镜像运行. -浏览器里访问 http://127.0.0.1:8080 就行. +浏览器打开 http://127.0.0.1:8080 访问服务端. ## (太长, 别看) 自己编译 如果你想自己检查代码(代码都有中英双语注释)再自己编译, 可以看看下面的东西.