docs(project): complete project setup and documentation
- Add agent system constitution with time recording standards - Add Git workflow documentation for all agents - Add comprehensive time recording policy (UTC + GMT+8) - Add CHANGELOG with version history - Add CONTRIBUTING guide with Git workflow and commit conventions - Add project specification document - Add README with project overview - Add .gitignore for macOS and editor files - Update CLAUDE.md with project requirements and metadata Project initialized: 2025-10-04 08:50:35 UTC / 16:50:35 GMT+8
This commit is contained in:
112
README.md
Normal file
112
README.md
Normal file
@@ -0,0 +1,112 @@
|
||||
# McDonald's IT Halloween Event Page 🎃
|
||||
|
||||
**Project Created**: 2025-10-04 08:50:35 UTC / 2025-10-04 16:50:35 GMT+8
|
||||
|
||||
A minimalist, geek-style Halloween event webpage for McDonald's IT department, inspired by Homebrew's terminal aesthetic.
|
||||
|
||||
## Project Description
|
||||
|
||||
This single-page website announces Halloween activities for McDonald's IT staff. It features:
|
||||
- Pure black background with terminal-style interface
|
||||
- ASCII art McDonald's logo as centerpiece
|
||||
- High-contrast monospace typography
|
||||
- Full responsive design (desktop + mobile)
|
||||
- Zero external dependencies
|
||||
|
||||
## Design Philosophy
|
||||
|
||||
**Extreme Minimalism + Geek Aesthetic**
|
||||
- No shadows, gradients, or decorative effects
|
||||
- Monospace fonts only
|
||||
- Command-line/terminal interface look
|
||||
- Homebrew-inspired design language
|
||||
|
||||
## Quick Start
|
||||
|
||||
1. Open `index.html` in any modern browser
|
||||
2. That's it! No build process, no dependencies.
|
||||
|
||||
## File Structure
|
||||
|
||||
```
|
||||
test-project/
|
||||
├── .claude/ # AI agent configurations
|
||||
│ ├── agents/ # Specialized AI agents
|
||||
│ └── constitution.md # Agent system principles
|
||||
├── CLAUDE.md # Project guidance for Claude AI
|
||||
├── README.md # This file
|
||||
└── index.html # Main event page (to be created)
|
||||
```
|
||||
|
||||
## Technical Specifications
|
||||
|
||||
- **HTML5**: Semantic markup
|
||||
- **CSS**: Inline styles for portability
|
||||
- **JavaScript**: Vanilla JS (minimal, if needed)
|
||||
- **Fonts**: System monospace fonts
|
||||
- **Encoding**: UTF-8
|
||||
- **Target Browsers**: Chrome, Firefox, Safari, Edge (latest versions)
|
||||
|
||||
## Responsive Breakpoints
|
||||
|
||||
- **Desktop**: 1024px and above
|
||||
- **Tablet**: 768px - 1023px
|
||||
- **Mobile**: 320px - 767px
|
||||
|
||||
## Development
|
||||
|
||||
### Prerequisites
|
||||
- Any modern web browser
|
||||
- Text editor (VS Code, Sublime, etc.)
|
||||
- Git for version control
|
||||
|
||||
### Repository
|
||||
- **Remote**: `ssh://gitea@git.shihong.me:2222/snowprint/halloween-test.git`
|
||||
- **Workflow**: Feature branches with pull requests
|
||||
- See `CONTRIBUTING.md` for detailed Git workflow
|
||||
|
||||
### Testing
|
||||
- Test on multiple screen sizes
|
||||
- Verify ASCII art legibility on mobile
|
||||
- Check color contrast ratios
|
||||
- Validate HTML5 compliance
|
||||
|
||||
## Deployment
|
||||
|
||||
Simply upload `index.html` to any web hosting service:
|
||||
- GitHub Pages
|
||||
- Netlify
|
||||
- Vercel
|
||||
- AWS S3
|
||||
- Traditional web hosting
|
||||
|
||||
## Browser Support
|
||||
|
||||
- Chrome 90+
|
||||
- Firefox 88+
|
||||
- Safari 14+
|
||||
- Edge 90+
|
||||
|
||||
## License
|
||||
|
||||
Internal use for McDonald's IT department.
|
||||
|
||||
## Version Control
|
||||
|
||||
This project uses Git for version control. All team members must:
|
||||
- Follow the branching strategy in `CONTRIBUTING.md`
|
||||
- Write clear, conventional commit messages
|
||||
- Never commit sensitive data
|
||||
- Request code review before merging to main
|
||||
|
||||
## Contributing
|
||||
|
||||
See `CONTRIBUTING.md` for detailed guidelines on:
|
||||
- Git workflow and branching strategy
|
||||
- Commit message conventions
|
||||
- Code review process
|
||||
- DevOps responsibilities
|
||||
|
||||
## Contact
|
||||
|
||||
For questions or updates, contact the McDonald's IT team.
|
||||
Reference in New Issue
Block a user