update

GitHub README Profile Generator Development Guidelines.md

@@ -1,265 +0,0 @@
-# GitHub README Profile Generator Development Guidelines
-
-## 1. Project Overview
-
-### 1.1 Project Description
-A Hugging Face Space application that helps users generate personalized GitHub README profiles through AI interaction and template customization.
-
-### 1.2 Core Features
-- AI-powered profile content generation
-- Template-based README structure
-- Interactive markdown preview
-- Section-by-section copying
-- Bulk markdown export
-- Live preview of generated content
-
-## 2. Technical Stack
-
-### 2.1 Core Technologies
-- Frontend Framework: Streamlit
-- AI Model: LLaMA/BLOOM (Open Source LLM)
-- Markdown Processing: Python-markdown
-- Version Control: Git
-
-### 2.2 Required Dependencies
-```requirements.txt
-streamlit>=1.24.0
-python-markdown>=3.4.0
-requests>=2.28.0
-python-dotenv>=0.19.0
-transformers>=4.30.0
-torch>=2.0.0
-```
-
-## 3. Project Structure
-```
-readme-profile-generator/
-├── app.py                 # Main Streamlit application
-├── src/
-│   ├── ai/               # AI interaction modules
-│   ├── components/       # UI components
-│   ├── templates/        # README templates
-│   └── utils/           # Helper functions
-├── tests/               # Test files
-├── .gitignore
-├── requirements.txt
-└── README.md
-```
-
-## 4. Development Phases
-
-### Phase 1: MVP (Basic Foundation)
-**Objective**: Create basic working prototype
-
-**Features**:
-1. Single-page Streamlit interface
-2. Basic user input form
-3. Simple markdown preview
-4. Copy button for full content
-
-**Testing Criteria**:
-- UI renders correctly
-- Form captures all basic information
-- Preview displays formatted markdown
-- Copy function works correctly
-
-### Phase 2: AI Integration
-**Objective**: Implement AI-powered content generation
-
-**Features**:
-1. AI model integration
-2. Basic prompt engineering
-3. Content suggestion system
-4. Error handling for AI responses
-
-**Testing Criteria**:
-- AI responds within 5 seconds
-- Generated content is relevant
-- Error messages are clear
-- Content format is valid markdown
-
-### Phase 3: Template System
-**Objective**: Add template selection and customization
-
-**Features**:
-1. Multiple template options
-2. Template preview
-3. Section customization
-4. Template switching
-
-**Testing Criteria**:
-- All templates load correctly
-- Preview updates instantly
-- Customizations persist
-- Templates maintain formatting
-
-### Phase 4: Advanced Features
-**Objective**: Implement section management and advanced copying
-
-**Features**:
-1. Section-by-section editing
-2. Individual section copying
-3. Bulk export options
-4. Session management
-
-**Testing Criteria**:
-- Sections can be individually modified
-- Copy functions work for all sections
-- Export includes all content
-- Sessions persist correctly
-
-## 5. Coding Standards
-
-### 5.1 Python Code Style
-- Follow PEP 8 guidelines
-- Use type hints
-- Maximum line length: 88 characters
-- Use descriptive variable names
-
-### 5.2 File Organization
-- One class per file
-- Group related functionality in modules
-- Keep files under 500 lines
-- Use appropriate file naming conventions
-
-### 5.3 Comments and Documentation
-- Each function must have docstrings
-- Complex logic requires inline comments
-- Update README.md with new features
-- Document all configuration options
-
-## 6. Testing Guidelines
-
-### 6.1 Testing Levels
-1. Unit Testing
-   - Test individual functions
-   - Test UI components
-   - Test markdown generation
-
-2. Integration Testing
-   - Test AI integration
-   - Test template system
-   - Test data flow
-
-3. User Acceptance Testing
-   - Test full user workflows
-   - Test edge cases
-   - Test error scenarios
-
-### 6.2 Test Cases Structure
-```python
-def test_feature():
-    # Setup
-    # Action
-    # Assert
-    # Cleanup
-```
-
-### 6.3 Testing Checklist
-- [ ] All new functions have unit tests
-- [ ] Integration tests pass
-- [ ] UI renders correctly
-- [ ] Error handling works
-- [ ] Performance meets requirements
-
-## 7. Deployment Guidelines
-
-### 7.1 Pre-deployment Checklist
-- [ ] All tests pass
-- [ ] Dependencies are updated
-- [ ] Environment variables are set
-- [ ] Documentation is updated
-
-### 7.2 Deployment Process
-1. Update requirements.txt
-2. Run full test suite
-3. Update Space secrets if needed
-4. Deploy to Hugging Face Space
-5. Verify deployment
-
-## 8. Version Control
-
-### 8.1 Branch Strategy
-- main: Production code
-- develop: Development branch
-- feature/*: New features
-- bugfix/*: Bug fixes
-
-### 8.2 Commit Guidelines
-- Use descriptive commit messages
-- Reference issue numbers
-- Keep commits focused
-- Follow conventional commits format
-
-## 9. Performance Requirements
-
-### 9.1 Response Times
-- Page load: < 3 seconds
-- AI response: < 5 seconds
-- Preview update: < 1 second
-- Copy operation: < 0.5 seconds
-
-### 9.2 Resource Usage
-- Memory usage < 512MB
-- CPU usage < 70%
-- Storage usage < 1GB
-
-## 10. Error Handling
-
-### 10.1 User Errors
-- Display clear error messages
-- Provide recovery suggestions
-- Maintain data integrity
-- Log user errors
-
-### 10.2 System Errors
-- Implement graceful degradation
-- Log detailed error information
-- Notify admin of critical errors
-- Provide fallback options
-
-## 11. Security Guidelines
-
-### 11.1 User Data
-- No sensitive data storage
-- Clear data usage policies
-- Implement rate limiting
-- Sanitize user inputs
-
-### 11.2 API Security
-- Use environment variables
-- Implement request validation
-- Monitor API usage
-- Handle token expiration
-
-## 12. Maintenance
-
-### 12.1 Regular Tasks
-- Update dependencies monthly
-- Review error logs weekly
-- Backup configurations
-- Monitor performance
-
-### 12.2 Documentation
-- Keep README updated
-- Document API changes
-- Update user guides
-- Maintain changelog
-
-## 13. Success Criteria
-
-### 13.1 Functional Requirements
-- All features work as specified
-- No critical bugs
-- Meets performance requirements
-- Passes all test cases
-
-### 13.2 User Experience
-- Intuitive interface
-- Clear feedback
-- Responsive design
-- Helpful error messages
-
----
-
-**Note**: This document should be treated as a living document and updated as the project evolves. Each phase should be completed and thoroughly tested before moving to the next phase.

app.py

@@ -4,7 +4,7 @@ import re
 import urllib.parse
 
 def load_template(template_path):
-    """加载 README 模板文件"""
+    """Load README template file"""
     with open(template_path, 'r', encoding='utf-8') as f:
         return f.read()
 
@@ -115,64 +115,113 @@ def main():
     )
     
     st.title("GitHub README Profile Generator")
-    st.markdown("### 生成你的个性化 GitHub Profile README")
+    st.markdown("### Create Your Personalized GitHub Profile README")
+    
+    # Add introduction and tutorial
+    st.info("""
+    👋 Welcome! This tool helps you create an awesome GitHub profile README.md file in a few simple steps.
+    
+    **How to use this generator:**
+    1. Fill in the forms in each section on the left
+    2. Preview your README in real-time on the right
+    3. When satisfied, click 'Copy Content' and paste it into your GitHub profile repository
+    
+    **To create your GitHub profile README:**
+    1. Create a new repository with the same name as your GitHub username
+    2. Initialize it with a README.md file
+    3. Paste the generated content and commit changes
+    """)
 
-    # 加载默认模板
+    # Load default template
     template_path = Path("README_template.md")
     template_content = load_template(template_path)
     
-    # 创建两列布局
+    # Create two-column layout
     col1, col2 = st.columns([1, 1])
 
     with col1:
-        st.subheader("基本信息")
+        st.subheader("Basic Information")
+        st.markdown("""
+        This section forms the header of your profile. Make it personal and engaging!
+        - **Name**: Your full name or preferred display name
+        - **Bio**: A brief introduction about yourself (1-2 sentences)
+        - **GitHub Username**: Your GitHub handle (used for generating links)
+        """)
         
-        # 基本信息表单
-        full_name = st.text_input("姓名", value="Chan Meng")
-        bio = st.text_input("个人简介", value="A minimalist")
-        github_username = st.text_input("GitHub 用户名", value="ChanMeng666")
+        # Basic information form
+        full_name = st.text_input("Full Name", value="Chan Meng")
+        bio = st.text_input("Bio", value="A passionate developer exploring the digital frontier")
+        github_username = st.text_input("GitHub Username", value="ChanMeng666")
         
-        # 社交链接
-        st.subheader("社交链接")
-        portfolio_link = st.text_input("作品集链接", value="https://chanmeng.live/")
-        linkedin_link = st.text_input("LinkedIn 链接", value="https://www.linkedin.com/in/chanmeng666/")
+        # Social Links
+        st.subheader("Social Links")
+        st.markdown("""
+        Connect with visitors through your professional networks.
+        Add your portfolio and LinkedIn URLs to showcase your work and experience.
+        """)
+        portfolio_link = st.text_input("Portfolio Website", value="https://chanmeng.live/")
+        linkedin_link = st.text_input("LinkedIn Profile", value="https://www.linkedin.com/in/chanmeng666/")
         
-        # 日常行为
-        st.subheader("日常行为")
-        daily_routine_1 = st.text_input("日常行为 1", value="code")
-        daily_routine_2 = st.text_input("日常行 2", value="eat")
-        daily_routine_3 = st.text_input("日常行为 3", value="sleep")
-        daily_routine_4 = st.text_input("日常行为 4", value="repeat")
+        # Daily Routine
+        st.subheader("Daily Routine")
+        st.markdown("""
+        Share your daily activities in a fun way! These will be displayed as an animated cycle.
+        Example: code → learn → create → repeat
+        """)
+        daily_routine_1 = st.text_input("Activity 1", value="code")
+        daily_routine_2 = st.text_input("Activity 2", value="learn")
+        daily_routine_3 = st.text_input("Activity 3", value="create")
+        daily_routine_4 = st.text_input("Activity 4", value="repeat")
         
-        # 项目信息
-        st.subheader("项目展示")
-        num_projects = st.number_input("项目数量", min_value=1, max_value=10, value=2)
+        # Projects Section
+        st.subheader("Featured Projects")
+        st.markdown("""
+        Showcase your best work! For each project, you'll need:
+        - Project name
+        - Project link (repository or demo)
+        - Screenshot/preview image
+        - GitHub repository link
+        - Live demo link
+        - Key features/highlights (3 points)
+        """)
+        num_projects = st.number_input("Number of Projects", min_value=1, max_value=10, value=2)
         
-        # 存储所有项目数据
+        # Store project data
         all_project_data = {}
         for i in range(1, num_projects + 1):
             project_data = create_project_fields(col1, i)
             all_project_data.update(project_data)
         
-        # 技能徽章
-        st.subheader("技能栈")
-        core_skills = st.text_area("核心技能 (用逗号分隔)", 
+        # Skills Section
+        st.subheader("Skills & Technologies")
+        st.markdown("""
+        List your technical skills separated by commas. They'll be converted into beautiful badges!
+        Example: Python, JavaScript, React, Docker
+        
+        Tip: Group similar skills together for better organization.
+        """)
+        core_skills = st.text_area("Core Skills", 
             value="React,Python,TypeScript,Machine Learning")
-        frontend_skills = st.text_area("前端技能 (用逗号分隔)", 
+        frontend_skills = st.text_area("Frontend Skills", 
             value="HTML5,CSS3,JavaScript,React Native")
-        backend_skills = st.text_area("后端技能 (用逗号分隔)", 
+        backend_skills = st.text_area("Backend Skills", 
             value="Node.js,MySQL,MongoDB")
 
-        # 生成徽章
+        # Generate badges
         core_skills_badges = process_skills(core_skills)
         frontend_skills_badges = process_skills(frontend_skills)
         backend_skills_badges = process_skills(backend_skills)
 
-        # 其他信息
-        st.subheader("其他信息")
-        footer_text = st.text_area("页脚文本", value="Thanks for visiting my GitHub profile! Feel free to connect or check out my projects.")
+        # Additional Information
+        st.subheader("Footer Message")
+        st.markdown("""
+        Add a personal touch with a closing message to your profile visitors.
+        This appears at the bottom of your profile README.
+        """)
+        footer_text = st.text_area("Footer Message", 
+            value="Thanks for visiting my GitHub profile! Feel free to connect or check out my projects.")
 
-        # 更新变量字典，加入项目数据
+        # Update variable dictionary, add project data
         variables = {
             'full_name': full_name or '',
             'bio': bio or '',
@@ -187,10 +236,10 @@ def main():
             'frontend_skills_badges': frontend_skills_badges,
             'backend_skills_badges': backend_skills_badges,
             'footer_text': footer_text,
-            **all_project_data  # 添加所有项目数据
+            **all_project_data  # Add all project data
         }
 
-        # 动态生成项目部分的模板内容
+        # Dynamic generate project section template content
         template_content = template_content.replace(
             "<!-- Featured Projects Section -->",
             f'''<!-- Featured Projects Section -->
@@ -199,16 +248,25 @@ def main():
 </table>'''
         )
 
-        # 生成预览内容
+        # Generate preview content
         preview_content = replace_template_variables(template_content, variables)
 
     with col2:
-        st.subheader("预览")
+        st.subheader("Live Preview")
+        st.markdown("""
+        See how your README looks in real-time. 
+        When you're ready, click 'Copy Content' below to get the markdown code.
+        """)
         st.markdown(preview_content, unsafe_allow_html=True)
         
-        if st.button("复制全部内容"):
+        if st.button("Copy Content"):
             st.code(preview_content, language="markdown")
-            st.success("内容已复制到剪贴板!")
+            st.success("""
+            Content copied! To update your GitHub profile:
+            1. Go to your profile repository (username/username)
+            2. Edit README.md
+            3. Paste this content and commit changes
+            """)
 
 if __name__ == "__main__":
     main()