Skip to content

Commit 538efe0

Browse files
qin-ctxqin-ctx
committed
feat: enable uv pkg management
1 parent f24412c commit 538efe0

File tree

3 files changed

+69
-52
lines changed

3 files changed

+69
-52
lines changed

‎CONTRIBUTING.md‎

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -76,39 +76,41 @@ Found a bug or have a feature request? [Create an issue](https://github.com/volc
7676

7777
Use descriptive branch names with appropriate prefixes:
7878

79-
| Prefix | Purpose | Example |
80-
| ------------------------- | ------------------------- | ----------------------------------- |
81-
| `feature/` or `feat/` | New features | `feature/add-notion-integration` |
82-
| `fix/` | Bug fixes | `fix/screenshot-capture-error` |
83-
| `hotfix/` | Critical production fixes | `hotfix/memory-leak` |
84-
| `docs/` | Documentation only | `docs/update-api-guide` |
85-
| `refactor/` | Code refactoring | `refactor/simplify-storage-layer` |
86-
| `test/` | Adding or updating tests | `test/add-processor-tests` |
87-
| `chore/` | Maintenance tasks | `chore/update-dependencies` |
79+
| Prefix | Purpose | Example |
80+
|--------|---------|---------|
81+
| `feature/` or `feat/` | New features | `feature/add-notion-integration` |
82+
| `fix/` | Bug fixes | `fix/screenshot-capture-error` |
83+
| `hotfix/` | Critical production fixes | `hotfix/memory-leak` |
84+
| `docs/` | Documentation only | `docs/update-api-guide` |
85+
| `refactor/` | Code refactoring | `refactor/simplify-storage-layer` |
86+
| `test/` | Adding or updating tests | `test/add-processor-tests` |
87+
| `chore/` | Maintenance tasks | `chore/update-dependencies` |
8888

8989
### Submitting Code
9090

9191
1. **Create a branch**
9292

9393
Follow the branch naming convention above:
94-
9594
```bash
9695
git checkout -b feature/your-feature-name
9796
# or
9897
git checkout -b fix/your-bug-fix
9998
```
99+
100100
2. **Make your changes**
101101

102102
- Follow [PEP 8](https://pep8.org/) style guidelines
103103
- Add tests for new features
104104
- Update documentation if needed
105+
105106
3. **Commit with clear messages**
106107

107108
```bash
108109
git commit -m "feat: add your feature description"
109110
# or
110111
git commit -m "fix: fix your bug description"
111112
```
113+
112114
4. **Push and create a Pull Request**
113115

114116
```bash

‎README.md‎

Lines changed: 44 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,14 @@ An open-source,proactive context-aware AI partner,dedicated to bringing clarity
1010

1111
<a href="https://github.com/volcengine/MineContext/issues">Report Issues</a> · <a href="https://bytedance.larkoffice.com/share/base/form/shrcnPAjJtlufuhBZGegll41NOh">Feedback</a>
1212

13+
[![][release-shield]][release-link]
14+
[![][github-stars-shield]][github-stars-link]
15+
[![][github-issues-shield]][github-issues-shield-link]
16+
[![][github-contributors-shield]][github-contributors-link]
17+
[![][license-shield]][license-shield-link]
18+
[![][last-commit-shield]][last-commit-shield-link]
19+
[![][wechat-shield]][wechat-shield-link]
20+
1321
[中文](README_zh.md) / English
1422

1523
👋 Join our [WeChat / Lark / Red Note Group](https://bytedance.larkoffice.com/wiki/Hg6VwrxnTiXtWUkgHexcFTqrnpg)
@@ -67,7 +75,7 @@ MineContext focuses on five key features: effortless collection, intelligent res
6775
3. 💡 Intelligent Resurfacing
6876
Surfaces relevant and useful context intelligently during creation. Ensures assisted creativity without overwhelming you with information.
6977
4. 🛡️ Privacy-First
70-
All data is stored locally, ensuring your privacy and security.
78+
All data is stored locally, ensuring your privacy and security.
7179
5. 🎯 Context Engineering Architecture
7280
Supports the complete lifecycle of multimodal, multi-source data—from capture, processing, and storage to management, retrieval, and consumption—enabling the generation of six types of intelligent context.
7381

@@ -86,7 +94,6 @@ Enter the following command in the terminal to disable the quarantine attribute
8694
```
8795
sudo xattr -d com.apple.quarantine "/Applications/MineContext.app"
8896
```
89-
9097
![Quarantine](src/Quarantine.gif)
9198

9299
### 3. Enter Your API-Key
@@ -107,6 +114,8 @@ After restarting the application, please first set your screen sharing area in
107114

108115
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].
109116

117+
118+
110119
## 💎 The Philosophy Behind the Name
111120

112121
The naming of MineContext also reflects the team's ingenuity. It signifies both "my context" and "mining context." It draws inspiration from the core philosophy of Minecraft—openness, creativity, and exploration.
@@ -133,39 +142,39 @@ We will prioritize the expansion of Context Sources according to the following p
133142
- P4: Personal deep context loop (WeChat, QQ chat data acquisition, mobile screenshots)
134143
- P5: Physical world context loop (smart wearable synchronization, smart glasses synchronization)
135144

136-
| Context Capture Capability | Context Source | Priority | Completion Status |
137-
| :--------------------------- | :---------------------------------------- | :------- | :---------------- |
138-
| Screen Screenshot | User PC Information | P0 | ✅ |
145+
| Context Capture Capability | Context Source | Priority | Completion Status |
146+
| :--------------------------- | :--------------------------------- | :------- | :---------------- |
147+
| Screen Screenshot | User PC Information | P0 | ✅ |
139148
| Note Editing | Application Internal Creation Information | P0 | ✅ |
140-
| Link Upload | Internet Information | P0 | |
141-
| File Upload | Structured Documents | P1 | |
142-
| File Upload | Unstructured Documents | P1 | |
143-
| File Upload | Images | P1 | |
144-
| File Upload | Audio | P4 | |
145-
| File Upload | Video | P4 | |
146-
| File Upload | Code | P4 | |
147-
| Browser Extension | AI Conversation Records | P2 | |
148-
| Browser Extension | Refined Internet Information | P5 | |
149-
| Meeting Records | Meeting Information | P2 | |
150-
| RSS | Consultation Information | P3 | |
151-
| Deep Research | High-Quality Research Analysis | P3 | |
152-
| Application MCP/API | Payment Records | P4 | |
153-
| Application MCP/API | Research Papers | P3 | |
154-
| Application MCP/API | News | P4 | |
155-
| Application MCP/API | Emails | P4 | |
156-
| Application MCP/API | Notion | P2 | |
157-
| Application MCP/API | Obsidian | P2 | |
158-
| Application MCP/API | Slack | P4 | |
159-
| Application MCP/API | Jira | P4 | |
160-
| Application MCP/API | Figma | P2 | |
161-
| Application MCP/API | Linear | P4 | |
162-
| Application MCP/API | Todoist | P4 | |
163-
| Memory Bank Migration Import | User Memory | P4 | |
164-
| WeChat Data Capture | WeChat Chat History | P4 | |
165-
| QQ Data Capture | QQ Chat History | P4 | |
166-
| Mobile Screenshot Monitor | User Mobile End Information | P4 | |
167-
| Smart Glasses Data Sync | Physical World Interaction Records | P5 | |
168-
| Smart Bracelet Data Sync | Physiological Data | P5 | |
149+
| Link Upload | Internet Information | P0 | |
150+
| File Upload | Structured Documents | P1 | |
151+
| File Upload | Unstructured Documents | P1 | |
152+
| File Upload | Images | P1 | |
153+
| File Upload | Audio | P4 | |
154+
| File Upload | Video | P4 | |
155+
| File Upload | Code | P4 | |
156+
| Browser Extension | AI Conversation Records | P2 | |
157+
| Browser Extension | Refined Internet Information | P5 | |
158+
| Meeting Records | Meeting Information | P2 | |
159+
| RSS | Consultation Information | P3 | |
160+
| Deep Research | High-Quality Research Analysis | P3 | |
161+
| Application MCP/API | Payment Records | P4 | |
162+
| Application MCP/API | Research Papers | P3 | |
163+
| Application MCP/API | News | P4 | |
164+
| Application MCP/API | Emails | P4 | |
165+
| Application MCP/API | Notion | P2 | |
166+
| Application MCP/API | Obsidian | P2 | |
167+
| Application MCP/API | Slack | P4 | |
168+
| Application MCP/API | Jira | P4 | |
169+
| Application MCP/API | Figma | P2 | |
170+
| Application MCP/API | Linear | P4 | |
171+
| Application MCP/API | Todoist | P4 | |
172+
| Memory Bank Migration Import | User Memory | P4 | |
173+
| WeChat Data Capture | WeChat Chat History | P4 | |
174+
| QQ Data Capture | QQ Chat History | P4 | |
175+
| Mobile Screenshot Monitor | User Mobile End Information | P4 | |
176+
| Smart Glasses Data Sync | Physical World Interaction Records | P5 | |
177+
| Smart Bracelet Data Sync | Physiological Data | P5 | |
169178

170179
## 🆚 Comparison with Familiar Application
171180

@@ -326,6 +335,7 @@ python -m opencontext.cli start
326335

327336
[![Star History Chart](https://api.star-history.com/svg?repos=volcengine/MineContext&type=Timeline)](https://www.star-history.com/#volcengine/MineContext&Timeline)
328337

338+
329339
## 📃 License
330340

331341
This repository is licensed under the Apache 2.0 License.

‎README_zh.md‎

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,13 @@
1010

1111
<a href="https://github.com/volcengine/MineContext/issues">反馈问题</a> · <a href="https://bytedance.larkoffice.com/share/base/form/shrcn2wgAfiyCVVwhvVYCXWNNdc">提交问卷</a>
1212

13-
14-
15-
16-
17-
18-
13+
[![][release-shield]][release-link]
14+
[![][github-stars-shield]][github-stars-link]
15+
[![][github-issues-shield]][github-issues-shield-link]
16+
[![][github-contributors-shield]][github-contributors-link]
17+
[![][license-shield]][license-shield-link]
18+
[![][last-commit-shield]][last-commit-shield-link]
19+
[![][wechat-shield]][wechat-shield-link]
1920

2021
中文 / [English](README.md)
2122

@@ -84,6 +85,7 @@ MineContext专注于五个核心功能：轻松收集、智能重显和主动交
8485

8586
![Download APP](src/Download-App.gif)
8687

88+
8789
### 2. 禁用隔离属性
8890

8991
在运行应用程序之前，在终端中输入以下命令以禁用隔离属性。
@@ -100,6 +102,7 @@ sudo xattr -d com.apple.quarantine "/Applications/MineContext.app"
100102

101103
![Enter API-Key](src/Enter-API-Key.gif)
102104

105+
103106
### 4. 开始记录
104107

105108
进入【Screen Monitor】启用屏幕分享的系统权限，设置完之后需要重新启动应用使其生效。
@@ -110,6 +113,7 @@ sudo xattr -d com.apple.quarantine "/Applications/MineContext.app"
110113

111114
![Screen-Settings](src/Screen-Settings.gif)
112115

116+
113117
### 5. 忘掉它
114118

115119
启动记录后，您的上下文将逐渐被收集。这会需要一些时间才能产生价值。所以说，忘记它，安心专注于其他任务吧。MineContext将会在后台为您生成待办事项、提示、摘要和活动。当然，您也可以通过【Chat with AI】进行主动问答。
@@ -142,8 +146,8 @@ MineContext 的命名，也体现了团队的巧思。既是“我的上下文
142146

143147
| 上下文捕获能力 | 上下文来源 | 优先级 | 完成状态 |
144148
| :--------------- | :--------------- | :----- | :------- |
145-
| 屏幕截图 | 用户PC信息 | P0 | ✅ |
146-
| 笔记编辑 | 应用内创作信息 | P0 | ✅ |
149+
| 屏幕截图 | 用户PC信息 | P0 | ✅ |
150+
| 笔记编辑 | 应用内创作信息 | P0 | ✅ |
147151
| 链接上传 | 互联网信息 | P0 | |
148152
| 文件上传 | 结构化文档 | P1 | |
149153
| 文件上传 | 非结构化文档 | P1 | |
@@ -331,6 +335,7 @@ python -m opencontext.cli start
331335

332336
[![Star History Chart](https://api.star-history.com/svg?repos=volcengine/MineContext&type=Timeline)](https://www.star-history.com/#volcengine/MineContext&Timeline)
333337

338+
334339
## 📃 许可证
335340

336341
本仓库在Apache 2.0许可证下发布。

0 commit comments

Comments
 (0)