From 541c2024b7998f76fa401106b659a06b10d30ae0 Mon Sep 17 00:00:00 2001 From: timochan Date: Fri, 7 Jul 2023 12:21:56 +0800 Subject: [PATCH 1/4] docs: fix some errors for readme --- .gitignore | 3 ++- README.md | 24 ++++++++++++++++-------- 2 files changed, 18 insertions(+), 9 deletions(-) diff --git a/.gitignore b/.gitignore index ad9f178..0223926 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,3 @@ .DS_Store -dist \ No newline at end of file +dist +node_modules \ No newline at end of file diff --git a/README.md b/README.md index 956560e..2c96fcb 100644 --- a/README.md +++ b/README.md @@ -52,15 +52,26 @@ ### Automatic | 自动安装 1. 下载最新的发布版本或从 [CI Release](https://github.com/wibus-wee/icalingua-theme-telegram/releases) 下载最新的构建版本。 -2. 在解压缩包后的目录下运行 `sh install.sh`。 -3. 重启 Icalingua++。 +2. 给予执行权限 `chmod +x install.sh` +3. 在解压缩包后的目录下运行 `./install.sh`。 +4. 重启 Icalingua++。 ### Manual | 手动安装 +#### 从 CI 下载 + 1. 下载最新的发布版本或从 [CI Release](https://github.com/wibus-wee/icalingua-theme-telegram/releases) 下载最新的构建版本。 -2. 将 `addon.js`, `style.css`, `main.js` 复制到 Icalingua++ 的[数据目录](https://github.com/Icalingua-plus-plus/Icalingua-plus-plus#%E9%BB%98%E8%AE%A4%E6%95%B0%E6%8D%AE%E7%9B%AE%E5%BD%95) +2. 将 `addon.js`, `style.css`, `main.js`, `config.js` 复制到 Icalingua++ 的[数据目录](https://github.com/Icalingua-plus-plus/Icalingua-plus-plus#%E9%BB%98%E8%AE%A4%E6%95%B0%E6%8D%AE%E7%9B%AE%E5%BD%95) 3. 重启 Icalingua++。 +#### 从源码安装 + +1. 克隆这个仓库。 +2. 安装依赖 `pnpm install`。 +3. 给予执行权限 `chmox +x replace.sh`。 +4. 运行 `./replace.sh`。 +5. 重启 Icalingua++。 + ## Enhancements & Feat. | 增强 & 新功能 这个文件用于帮助一些由于 DOM 结构的原因无法直接通过改变 CSS 实现目标样式的元素。已经实现的功能有： @@ -78,16 +89,15 @@ - [ ] 更改模态框的样式，使其更加美观。 - [ ] 鼠标滑动以回复消息 - ## Config | 配置 在 [#32](https://github.com/wibus-wee/icalingua-theme-telegram/pull/32) 中，我们引入了一个新的配置文件 `config.js`，你可以在这个文件中配置你想要启动的功能。有关这个文件的配置项定义，你可以前往 [types.d.ts](./types.d.ts) 查看。在此我简单介绍一下配置项： > **Note** -> +> > **不知道咋写的先学下 JavaScript 吧，或者将 `manual` 设置为 false，这样所有功能都会启动。** -### core -- 启动的核心功能。 +### core -- 启动的核心功能 你可以去前往 [core](./src/core//index.ts) 查看所有的核心功能。你需要填入的是核心功能的 Key。如： @@ -103,7 +113,6 @@ 与 [core](#core----启动的核心功能) 类似，你可以去前往 [chatbox](./src/functions/index.ts) 查看所有的聊天框修改功能。你需要填入的是聊天框修改功能的 Key。 - ### 其他注意事项 - 你可以在 `config.js` 中设置 `manual` 为 `false` 来启动所有功能。 @@ -119,7 +128,6 @@ |---|---| |light|dark| - ## Author Telegram Theme For Icalingua++ © Wibus, Released under AGPLv3. Created on Jul 1, 2023 From ba04429b87673a679eb0b3d389357a2f69112102 Mon Sep 17 00:00:00 2001 From: timochan Date: Fri, 7 Jul 2023 12:25:55 +0800 Subject: [PATCH 2/4] fix: typo --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index c11fc56..d010b23 100644 --- a/README.md +++ b/README.md @@ -67,7 +67,7 @@ 1. 克隆这个仓库。 2. 安装依赖 `pnpm install`。 -3. 给予执行权限 `chmox +x replace.sh`。 +3. 给予执行权限 `chmod +x replace.sh`。 4. 运行 `./replace.sh`。 5. 重启 Icalingua++。 From 584b0fa81a32eab17b3403c2eb5a18f680b4ff1f Mon Sep 17 00:00:00 2001 From: timochan Date: Fri, 7 Jul 2023 12:31:19 +0800 Subject: [PATCH 3/4] chore: update --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index d010b23..9ab1a9d 100644 --- a/README.md +++ b/README.md @@ -67,8 +67,8 @@ 1. 克隆这个仓库。 2. 安装依赖 `pnpm install`。 -3. 给予执行权限 `chmod +x replace.sh`。 -4. 运行 `./replace.sh`。 +3. 给予执行权限 `chmod +x dist/install.sh`。 +4. 运行 `./dist/install.sh`。 5. 重启 Icalingua++。 ## Enhancements & Feat. | 增强 & 新功能 From ee80c8394435d96320063a11808b4654ca71be7e Mon Sep 17 00:00:00 2001 From: timochan Date: Fri, 7 Jul 2023 12:43:03 +0800 Subject: [PATCH 4/4] chore: update --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 9ab1a9d..c560998 100644 --- a/README.md +++ b/README.md @@ -68,7 +68,7 @@ 1. 克隆这个仓库。 2. 安装依赖 `pnpm install`。 3. 给予执行权限 `chmod +x dist/install.sh`。 -4. 运行 `./dist/install.sh`。 +4. 运行 `cd dist && ./install.sh`。 5. 重启 Icalingua++。 ## Enhancements & Feat. | 增强 & 新功能