Skip to content

Commit c3e3100

Browse files
docs:add user guide with GIFs
1 parent ac7c7b8 commit c3e3100

File tree

7 files changed

+38
-12
lines changed

7 files changed

+38
-12
lines changed

README.md

Lines changed: 16 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ Table of Contents
4141
- [Installation](#installation)
4242
- [Configuration](#configuration)
4343
- [Running the Server](#running-the-server)
44-
- [👥 Community](#-community)
44+
- [👥 Community](#-community)
4545
- [Community and Support](#community-and-support)
4646
- [📃 License](#-license)
4747

@@ -72,7 +72,9 @@ MineContext focuses on five key features: effortless collection, intelligent res
7272

7373
### 1. Installation
7474

75-
Click Below Link or Github Latest Release to Download
75+
Click [Github Latest Release](https://github.com/volcengine/MineContext/releases) to Download
76+
77+
![Download APP](src/Download-App.gif)
7678

7779
### 2. Disable the quarantine attribute
7880

@@ -81,18 +83,27 @@ Enter the following command in the terminal to disable the quarantine attribute
8183
```
8284
sudo xattr -d com.apple.quarantine "/Applications/MineContext.app"
8385
```
86+
![Quarantine](src/Quarantine.gif)
8487

8588
### 3. Enter Your API-Key
8689

87-
After the application loads, follow the instructions to enter your API-Key. We currently support Doubao and OpenAI, with more platforms and local Ollama models to be added in the future.
90+
After the application loads(initial run may require installation of some backend environments, which may take a few minutes), follow the instructions to enter your API-Key. We currently support Doubao and OpenAI, with more platforms and local Ollama models to be added in the future.
91+
92+
![Enter API-Key](src/Enter-API-Key.gif)
8893

8994
### 4. Start Recording
9095

91-
Enter the 【Settings】 in 【Screen Monitor】 to set your screen sharing area, and click 【Start Recording】 to begin.
96+
Enter 【Screen Monitor】 to enable the system permissions for screen sharing. After completing the setup, you need to restart the application for the changes to take effect.
97+
![Enable-Permissions](src/Enable-Permissions.gif)
98+
99+
After restarting the application, please first set your screen sharing area in 【Settings】, then click [Start Recording] to begin taking screenshots.
100+
![Screen-Settings](src/Screen-Settings.gif)
92101

93102
### 5. Forget it
94103

95-
After starting recording, your Context will be gradually collected. Then, forget about it and focus on other tasks with peace of mind. MineContext will generate todos, tips, summaries, and activities for you one after another. Of course, you can also engage in proactive Q&A through 【Chat With AI】.
104+
After starting the recording, your context will gradually be collected. It will take some time to generate value. So, forget about it and focus on other tasks with peace of mind. MineContext will generate to-dos, prompts, summaries, and activities for you in the background. Of course, you can also engage in proactive Q&A through [Chat with AI].
105+
106+
96107

97108
## 💎 The Philosophy Behind the Name
98109

README_zh.md

Lines changed: 22 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727
- [2. 禁用隔离属性](#2-禁用隔离属性)
2828
- [3. 输入您的API密钥](#3-输入您的api密钥)
2929
- [4. 开始记录](#4-开始记录)
30-
- [5. 让我们忘记它](#5-让我们忘记它)
30+
- [5. 忘掉它](#5-忘掉它)
3131
- [💎 MineContext与我的世界](#-minecontext与我的世界)
3232
- [🎯 目标用户](#-目标用户)
3333
- [🔌 上下文来源](#-上下文来源)
@@ -42,8 +42,8 @@
4242
- [🚀 后端使用](#-后端使用)
4343
- [安装](#安装)
4444
- [配置](#配置)
45-
- [运行服务](#运行服务器)
46-
- [👥 社区](#-社区-1)
45+
- [运行服务器](#运行服务器)
46+
- [👥 社区](#-社区-1)
4747
- [社区与支持](#社区与支持-1)
4848
- [📃 许可证](#-许可证)
4949

@@ -74,6 +74,9 @@ MineContext专注于三个核心功能:轻松收集、智能重显和主动交
7474

7575
点击 [Github Latest Release](https://github.com/volcengine/MineContext/releases) 下载最新版本。
7676

77+
![Download APP](src/Download-App.gif)
78+
79+
7780
### 2. 禁用隔离属性
7881

7982
在运行应用程序之前,在终端中输入以下命令以禁用隔离属性。
@@ -82,17 +85,29 @@ MineContext专注于三个核心功能:轻松收集、智能重显和主动交
8285
sudo xattr -d com.apple.quarantine "/Applications/MineContext.app"
8386
```
8487

88+
![Quarantine](src/Quarantine.gif)
89+
8590
### 3. 输入您的API密钥
8691

87-
应用程序加载后,按照引导输入您的API密钥。我们目前支持豆包和OpenAI,未来将添加更多平台和本地Ollama模型。
92+
应用程序加载后(初次运行时需要安装一些后端环境,可能需要等待两分钟左右),按照引导输入您的API密钥。我们目前支持豆包和OpenAI,未来将添加更多平台和本地Ollama模型。
93+
94+
![Enter API-Key](src/Enter-API-Key.gif)
95+
8896

8997
### 4. 开始记录
9098

91-
进入【Screen Monitor】启用屏幕分享的系统权限,然后进入【Settings】设置您的屏幕共享区域,点击【Start Recording】开始。
99+
进入【Screen Monitor】启用屏幕分享的系统权限,设置完之后需要重新启动应用使其生效。
100+
101+
![Enable-Permissions](src/Enable-Permissions.gif)
102+
103+
重新启动应用后,请先在【Settings】设置您的屏幕共享区域,然后点击【Start Recording】开始截图。
104+
105+
![Screen-Settings](src/Screen-Settings.gif)
106+
92107

93-
### 5. 让我们忘记它
108+
### 5. 忘掉它
94109

95-
启动记录后,您的上下文将逐渐被收集。然后,忘记它,安心专注于其他任务吧。MineContext将会在后台为您生成待办事项、提示、摘要和活动。当然,您也可以通过【Chat with AI】进行主动问答。
110+
启动记录后,您的上下文将逐渐被收集。这会需要一些时间才能产生价值。所以说,忘记它,安心专注于其他任务吧。MineContext将会在后台为您生成待办事项、提示、摘要和活动。当然,您也可以通过【Chat with AI】进行主动问答。
96111

97112
## 💎 MineContext与我的世界
98113

src/Download-App.gif

1.78 MB
Loading

src/Enable-Permissions.gif

3.72 MB
Loading

src/Enter-API-Key.gif

2.78 MB
Loading

src/Quarantine.gif

11.5 MB
Loading

src/Screen-Settings.gif

1.05 MB
Loading

0 commit comments

Comments
 (0)