Skip to content

Commit d5279fd

Browse files
authored
docs: update README docs (#277)
1 parent a0f873e commit d5279fd

File tree

2 files changed

+48
-28
lines changed

2 files changed

+48
-28
lines changed

README-zh.md

Lines changed: 39 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -16,14 +16,14 @@
1616
## 🛠️ 技术栈
1717

1818
- **框架**: Expo React Native
19-
- **包管理器**: Yarn
19+
- **包管理器**: Pnpm
2020
- **UI**: Tamagui
2121
- **路由**: React Navigation
2222
- **状态管理**: Redux Toolkit
2323

2424
## 🚀 开发
2525

26-
> 相关开发文档在docs中
26+
> 相关开发文档在 docs 文件夹中
2727
2828
1. **克隆仓库**
2929

@@ -40,76 +40,91 @@
4040
3. **安装依赖**
4141

4242
```bash
43-
yarn install
43+
pnpm install
4444
```
4545

4646
4. **生成数据库**
4747

4848
```bash
4949
npx drizzle-kit generate
5050
```
51+
5. **构建 MCP Streamable Http**
52+
```bash
53+
cd packages/react-native-streamable-http
54+
npm install
55+
npm run build
56+
```
57+
6. **启动应用程序**
5158

52-
5. **启动应用**
53-
54-
ios:
59+
iOS:
5560

5661
```bash
5762
npx expo prebuild -p ios
5863

59-
cd ios 添加自签证书
64+
cd ios # 添加自签证书
6065

6166
npx expo run:ios -d
6267
```
6368

64-
android:
69+
Android:
6570

6671
```bash
6772
npx expo prebuild -p android
6873

69-
cd android # 配置 Android SDK 路径到 local.properties
74+
cd android # 在 local.properties 中添加 Android SDK 路径
7075

7176
npx expo run:android -d
7277
```
7378

74-
### Android SDK 配置
79+
### Android SDK 设置
7580

76-
#### Windows 用户:
81+
#### Windows 用户:
82+
83+
```
84+
sdk.dir=C:\\Users\\UserName\\AppData\\Local\\Android\\sdk
85+
```
7786

78-
`local.properties` 添加:
87+
或 (适用于较新版本的 Android Studio / IntelliJ IDEA):
7988

8089
```
81-
sdk.dir=C:\\Users\\您的用户名\\AppData\\Local\\Android\\sdk
90+
sdk.dir=C\:\\Users\\USERNAME\\AppData\\Local\\Android\\sdk
8291
```
8392

84-
或者(新版本 Android Studio 适用):
93+
其中 USERNAME 是您的电脑用户名。同时,请确保文件夹名为 sdk 或 Sdk。
94+
95+
示例:
8596

8697
```
87-
sdk.dir=C\:\\Users\\您的用户名\\AppData\\Local\\Android\\sdk
98+
sdk.dir=C:\\Users\\USERNAME\\AppData\\Local\\Android\\sdk
8899
```
89100

90-
注意将 `您的用户名` 替换为你的实际电脑用户名,且确保文件夹名称为 sdk 或 Sdk。
101+
或:
102+
103+
```
104+
sdk.dir=C\:\\Users\\USERNAME\\AppData\\Local\\Android\\Sdk
105+
```
91106

92-
#### Mac 用户
107+
#### Mac 用户:
93108

94109
```
95-
sdk.dir = /Users/用户名/Library/Android/sdk
110+
sdk.dir = /Users/USERNAME/Library/Android/sdk
96111
```
97112

98-
请将 `用户名` 替换为你的 macOS 用户名。
113+
其中 USERNAME 是您的 OSX 用户名。
99114

100-
你也可以通过环境变量设置:
115+
您也可以在路径中使用环境变量,例如:
101116

102117
```bash
103118
export ANDROID_HOME=/Users/$(whoami)/Library/Android/sdk
104119
export PATH="$PATH:$ANDROID_HOME/platform-tools:$ANDROID_HOME/tools"
105120
```
106121

107-
#### Linux (Ubuntu) 用户
122+
#### Linux (Ubuntu) 用户:
108123

109124
```
110-
sdk.dir = /home/用户名/Android/Sdk
125+
sdk.dir = /home/USERNAME/Android/Sdk
111126
```
112127

113-
`用户名` 替换为你的 Linux 用户名。
128+
其中 USERNAME 是您的 Linux 用户名。
114129

115-
> 请使用真机或者模拟器开发,不要使用Expo Go
130+
> 请使用实体设备或模拟器进行开发,请勿使用 Expo Go

README.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ English | [中文](./README-zh.md)
1616
## 🛠️ Tech Stack
1717

1818
- **Framework**: Expo React Native
19-
- **Package Manager**: Yarn
19+
- **Package Manager**: Pnpm
2020
- **UI**: Tamagui
2121
- **Routing**: React Navigation
2222
- **State Management**: Redux Toolkit
@@ -40,16 +40,21 @@ English | [中文](./README-zh.md)
4040
3. **Install dependencies**
4141

4242
```bash
43-
yarn install
43+
pnpm install
4444
```
4545

4646
4. **Generate database**
4747

4848
```bash
4949
npx drizzle-kit generate
5050
```
51-
52-
5. **Start the application**
51+
5. **Build the MCP Streamable Http**
52+
```bash
53+
cd packages/react-native-streamable-http
54+
npm install
55+
npm run build
56+
```
57+
6. **Start the application**
5358

5459
iOS:
5560

0 commit comments

Comments
 (0)