Skip to content

Commit 47c5983

Browse files
YihuiLuYihuiLu
committed
docs: 更新项目文档，添加中英文版本和语言切换
- 更新主README文件，修正硬件平台信息（Orange Pi Zero 2W） - 更新许可证描述为CC BY-NC-SA 4.0 - 创建英文版README (README_EN.md) - 更新PyCharm开发指南，改为文件同步方式 - 更新开发文档，提供完整的开发指引 - 添加中英文文档互相跳转链接 - 修正GitHub仓库链接 - 更新快速开始指南，创建英文版本
1 parent e831afb commit 47c5983

10 files changed

Lines changed: 513 additions & 215 deletions

File tree

‎CLAUDE.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -159,7 +159,7 @@ python -m ogscope.main
159159

160160
## Git 工作流
161161

162-
目前还没上传到Git
162+
项目已上传到GitHub: https://github.com/OG-star-tech/OGScope
163163
- 主分支: `main` (稳定版本)
164164
- 开发分支: `dev` (开发版本)
165165
- 功能分支: `feature/xxx`

‎CONTRIBUTING.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
如果你发现了 bug，请：
1010

11-
1. 在 [Issues](https://github.com/your-username/OGScope/issues) 页面搜索是否已有相关问题
11+
1. 在 [Issues](https://github.com/OG-star-tech/OGScope/issues) 页面搜索是否已有相关问题
1212
2. 如果没有，创建新 Issue，包含：
1313
- 详细的问题描述
1414
- 复现步骤
@@ -27,7 +27,7 @@
2727
1. **Fork 项目**
2828
```bash
2929
# 在 GitHub 上点击 Fork 按钮
30-
git clone https://github.com/your-username/OGScope.git
30+
git clone https://github.com/OG-star-tech/OGScope.git
3131
cd OGScope
3232
```
3333

@@ -129,7 +129,7 @@
129129
如果你在贡献过程中遇到问题：
130130

131131
- 查看 [开发文档](docs/development/README.md)
132-
- 在 [Discussions](https://github.com/your-username/OGScope/discussions) 提问
132+
- 在 [Discussions](https://github.com/OG-star-tech/OGScope/discussions) 提问
133133
- 联系维护者
134134

135135
感谢你的贡献！🎉

‎README.md‎

Lines changed: 21 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
11
# OGScope - 电子极轴镜
22

3-
基于 Raspberry Pi Zero 2W 的智能电子极轴镜系统
3+
基于 Orange Pi Zero 2W 的智能电子极轴镜系统，用于天文摄影中的精确极轴校准。
4+
5+
[English](README_EN.md) | 中文
46

57
## 硬件平台
68

7-
- **主控**: Raspberry Pi Zero 2W
8-
- **操作系统**: Raspberry Pi OS
9+
- **主控**: Orange Pi Zero 2W
10+
- **操作系统**: Ubuntu/Debian Linux
911
- **摄像头**: IMX327 MIPI 传感器
1012
- **显示屏**: 2.4寸 SPI LCD
1113
- **通信**: WiFi 无线控制
@@ -35,13 +37,13 @@
3537

3638
- Python 3.9+
3739
- Poetry 1.2+
38-
- Raspberry Pi Zero 2W (Raspberry Pi OS)
40+
- Orange Pi Zero 2W (Ubuntu/Debian Linux)
3941

4042
### 安装
4143

4244
```bash
4345
# 克隆项目
44-
git clone https://github.com/your-username/OGScope.git
46+
git clone https://github.com/OG-star-tech/OGScope.git
4547
cd OGScope
4648

4749
# 安装依赖（使用 Poetry）
@@ -56,18 +58,20 @@ python -m ogscope.main
5658

5759
### Web 界面访问
5860

59-
启动后访问: http://raspberrypi.local:8000 或 http://<IP>:8000
61+
启动后访问: http://orangepi.local:8000 或 http://<IP>:8000
6062

6163
## 开发
6264

6365
详见 [开发文档](docs/development/README.md)
6466

6567
### 远程开发配置 (PyCharm Pro)
6668

67-
1. 配置 SSH 连接到 Raspberry Pi
68-
2. 设置远程 Python 解释器
69-
3. 配置自动部署和同步
70-
4. 详细步骤见 [PyCharm 远程开发指南](docs/development/pycharm-remote.md)
69+
推荐使用 PyCharm 的文件同步功能进行开发：
70+
71+
1. 配置 SSH 连接到 Orange Pi Zero 2W
72+
2. 设置文件自动同步到开发板
73+
3. 在本地开发，远程测试硬件功能
74+
4. 详细步骤见 [PyCharm 文件同步开发指南](docs/development/pycharm-remote.md)
7175

7276
## 项目结构
7377

@@ -93,7 +97,13 @@ OGScope/
9397

9498
## 许可证
9599

96-
MIT License - 详见 [LICENSE](LICENSE) 文件
100+
本项目采用 [CC BY-NC-SA 4.0](https://creativecommons.org/licenses/by-nc-sa/4.0/) 许可证
101+
102+
- **署名 (BY)**: 必须标明原作者
103+
- **非商业性使用 (NC)**: 禁止商业用途
104+
- **相同方式共享 (SA)**: 衍生作品必须使用相同许可证
105+
106+
详见 [LICENSE](LICENSE) 文件
97107

98108
## 贡献
99109

‎README_EN.md‎

Lines changed: 114 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,114 @@
1+
# OGScope - Electronic Polar Scope
2+
3+
An intelligent electronic polar scope system based on Orange Pi Zero 2W for precise polar alignment in astrophotography.
4+
5+
English | [中文](README.md)
6+
7+
## Hardware Platform
8+
9+
- **Main Controller**: Orange Pi Zero 2W
10+
- **Operating System**: Ubuntu/Debian Linux
11+
- **Camera**: IMX327 MIPI sensor
12+
- **Display**: 2.4" SPI LCD
13+
- **Communication**: WiFi wireless control
14+
15+
## Features
16+
17+
### Phase 1 - Basic Features (MVP)
18+
- ✅ Real-time video preview
19+
- ✅ Web remote control
20+
- ✅ Basic polar alignment
21+
- ✅ Camera parameter adjustment
22+
23+
### Phase 2 - Complete Features
24+
- ⏳ SPI screen display
25+
- ⏳ Automatic plate solving
26+
- ⏳ Mobile app control
27+
- ⏳ Calibration data management
28+
29+
### Phase 3 - Ecosystem Integration
30+
- ⏳ INDI driver support
31+
- ⏳ Mount control
32+
- ⏳ Multi-device coordination
33+
34+
## Quick Start
35+
36+
### Requirements
37+
38+
- Python 3.9+
39+
- Poetry 1.2+
40+
- Orange Pi Zero 2W (Ubuntu/Debian Linux)
41+
42+
### Installation
43+
44+
```bash
45+
# Clone the project
46+
git clone https://github.com/OG-star-tech/OGScope.git
47+
cd OGScope
48+
49+
# Install dependencies (using Poetry)
50+
poetry install
51+
52+
# Activate virtual environment
53+
poetry shell
54+
55+
# Run the application
56+
python -m ogscope.main
57+
```
58+
59+
### Web Interface Access
60+
61+
After startup, visit: http://orangepi.local:8000 or http://<IP>:8000
62+
63+
## Development
64+
65+
See [Development Documentation](docs/development/README.md) for details.
66+
67+
### Remote Development Configuration (PyCharm Pro)
68+
69+
Recommended approach using PyCharm's file synchronization:
70+
71+
1. Configure SSH connection to Orange Pi Zero 2W
72+
2. Set up automatic file synchronization to the development board
73+
3. Develop locally, test hardware functions remotely
74+
4. Detailed steps in [PyCharm File Sync Development Guide](docs/development/pycharm-remote.md)
75+
76+
## Project Structure
77+
78+
```
79+
OGScope/
80+
├── ogscope/ # Main application package
81+
│ ├── core/ # Core functionality modules
82+
│ ├── hardware/ # Hardware interface layer
83+
│ ├── web/ # FastAPI web service
84+
│ ├── ui/ # SPI screen interface
85+
│ ├── algorithms/ # Astronomical algorithms
86+
│ └── utils/ # Utility functions
87+
├── tests/ # Test code
88+
├── docs/ # Documentation
89+
├── scripts/ # Deployment scripts
90+
└── web/ # Web frontend resources
91+
```
92+
93+
## Reference Projects
94+
95+
- [PiFinder](https://github.com/brickbots/PiFinder) - Plate solving star finder
96+
- [OpenMV Polar Scope](https://frank26080115.github.io/OpenMV-Astrophotography-Gear/doc/Polar-Scope.html) - Polar scope reference
97+
98+
## License
99+
100+
This project is licensed under [CC BY-NC-SA 4.0](https://creativecommons.org/licenses/by-nc-sa/4.0/)
101+
102+
- **Attribution (BY)**: Must credit the original author
103+
- **NonCommercial (NC)**: Commercial use is prohibited
104+
- **ShareAlike (SA)**: Derivative works must use the same license
105+
106+
See [LICENSE](LICENSE) file for details.
107+
108+
## Contributing
109+
110+
Issues and Pull Requests are welcome!
111+
112+
## Acknowledgments
113+
114+
Thanks to the PiFinder project for its open-source contributions, which provided valuable reference for this project.

‎docs/QUICK_START.md‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,11 @@
22

33
本指南将帮助你快速搭建 OGScope 开发环境。
44

5+
English | [中文](QUICK_START.md)
6+
57
## 🎯 目标
68

7-
- ✅ 在 Raspberry Pi Zero 2W 上运行 OGScope
9+
- ✅ 在 Orange Pi Zero 2W 上运行 OGScope
810
- ✅ 配置 PyCharm Professional 远程开发
911
- ✅ 通过 Web 界面访问系统
1012

‎docs/QUICK_START_EN.md‎

Lines changed: 158 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,158 @@
1+
# OGScope Quick Start Guide
2+
3+
This guide will help you quickly set up the OGScope development environment.
4+
5+
English | [中文](QUICK_START.md)
6+
7+
## 🎯 Goals
8+
9+
- ✅ Run OGScope on Orange Pi Zero 2W
10+
- ✅ Configure PyCharm Professional remote development
11+
- ✅ Access the system through web interface
12+
13+
## 📋 Prerequisites
14+
15+
### Hardware Requirements
16+
17+
- Orange Pi Zero 2W development board
18+
- IMX327 camera module
19+
- 2.4" SPI LCD display
20+
- MicroSD card (32GB+)
21+
- Power supply (5V/2A)
22+
23+
### Software Requirements
24+
25+
- macOS/Windows/Linux development machine
26+
- PyCharm Professional 2025
27+
- Python 3.9+
28+
- Poetry package manager
29+
30+
## 🚀 Installation Steps
31+
32+
### Step 1: Prepare Orange Pi Zero 2W
33+
34+
1. **Flash the OS**
35+
```bash
36+
# Download Ubuntu/Debian image for Orange Pi Zero 2W
37+
# Flash to microSD card using balenaEtcher
38+
```
39+
40+
2. **Initial Setup**
41+
```bash
42+
# Boot the board and connect via SSH
43+
ssh pi@orangepi.local
44+
45+
# Update system
46+
sudo apt update && sudo apt upgrade -y
47+
48+
# Install essential packages
49+
sudo apt install -y python3.9 python3-pip python3-venv git
50+
```
51+
52+
3. **Install Poetry**
53+
```bash
54+
curl -sSL https://install.python-poetry.org | python3 -
55+
echo 'export PATH="$HOME/.local/bin:$PATH"' >> ~/.bashrc
56+
source ~/.bashrc
57+
```
58+
59+
### Step 2: Clone and Setup Project
60+
61+
```bash
62+
# Clone the repository
63+
git clone https://github.com/OG-star-tech/OGScope.git
64+
cd OGScope
65+
66+
# Install dependencies
67+
poetry install
68+
69+
# Activate virtual environment
70+
poetry shell
71+
```
72+
73+
### Step 3: Configure PyCharm
74+
75+
1. **Open Project**
76+
- Launch PyCharm Professional
77+
- Open the OGScope project directory
78+
79+
2. **Configure File Sync**
80+
- Go to `Tools` → `Deployment` → `Configuration`
81+
- Add SFTP server for Orange Pi Zero 2W
82+
- Configure automatic file synchronization
83+
84+
3. **Setup Run Configurations**
85+
- Create local run configuration for development
86+
- Create remote run configuration for hardware testing
87+
88+
### Step 4: Run the Application
89+
90+
```bash
91+
# Local development
92+
python -m ogscope.main
93+
94+
# Remote testing (on Orange Pi)
95+
ssh orangepi
96+
cd /home/pi/OGScope
97+
poetry run python -m ogscope.main
98+
```
99+
100+
## 🌐 Access Web Interface
101+
102+
After starting the application, access:
103+
- Local: http://localhost:8000
104+
- Remote: http://orangepi.local:8000
105+
106+
## 🔧 Development Workflow
107+
108+
1. **Local Development**
109+
- Write code in PyCharm
110+
- Test basic functionality locally
111+
- Use local run configuration
112+
113+
2. **File Synchronization**
114+
- Files automatically sync to Orange Pi
115+
- Manual sync when needed
116+
117+
3. **Hardware Testing**
118+
- Switch to remote run configuration
119+
- Test camera and hardware features
120+
- Debug on actual hardware
121+
122+
## 📚 Next Steps
123+
124+
- Read [Development Guide](development/README.md)
125+
- Check [PyCharm Remote Development](development/pycharm-remote.md)
126+
- Explore [API Documentation](API_ARCHITECTURE.md)
127+
128+
## 🆘 Troubleshooting
129+
130+
### Common Issues
131+
132+
1. **Connection Problems**
133+
```bash
134+
# Check network connectivity
135+
ping orangepi.local
136+
137+
# Verify SSH connection
138+
ssh orangepi
139+
```
140+
141+
2. **Permission Issues**
142+
```bash
143+
# Fix camera permissions
144+
sudo usermod -a -G video pi
145+
sudo reboot
146+
```
147+
148+
3. **Dependency Issues**
149+
```bash
150+
# Reinstall dependencies
151+
poetry install --sync
152+
```
153+
154+
## 📞 Support
155+
156+
- [GitHub Issues](https://github.com/OG-star-tech/OGScope/issues)
157+
- [Discussions](https://github.com/OG-star-tech/OGScope/discussions)
158+
- [Documentation](README.md)

0 commit comments

Comments
 (0)