Skip to content

Commit 5f35e5c

Browse files
committed
add readme_en
1 parent be0b330 commit 5f35e5c

8 files changed

Lines changed: 121 additions & 2 deletions

File tree

README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
11
# 🌟 StarScope / 星探
2+
🌍 **English users**: View the English version → [README_en.md](README_en.md)
3+
👉 This is the main (Chinese) README. The site itself is bilingual: [StarScope](https://github-stars.xjmunity.com/)
24

35
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
46
[![GitHub Pages](https://img.shields.io/badge/Deployed%20on-GitHub%20Pages-89216B.svg)](https://jungleAI404.github.io/github-daily-star/)
@@ -7,7 +9,7 @@
79
> **English Name**:StarScope
810
> 一份由开发者**人工精心挑选**的 GitHub 高增长项目推荐列表,每日更新,极简呈现。
911
10-
🌐 **在线访问**[https://githubStar.xjmunity.com](https://githubStar.xjmunity.com)
12+
🌐 **在线访问**[星探](https://github-stars.xjmunity.com/)
1113

1214
---
1315

@@ -83,4 +85,5 @@ star-scope/
8385
├── static/ # 静态资源(CSS, JS)
8486
├── translations/ # 多语言文案翻译(site_name, nav, etc.)
8587
├── output/ # 构建输出目录(部署内容)
86-
└── README.md
88+
└── README.md
89+
└── README_en.md

README_en.md

Lines changed: 116 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,116 @@
1+
# 🌟 StarScope
2+
![License](https://img.shields.io/badge/License-MIT-blue.svg)
3+
![Deployed on GitHub Pages](https://img.shields.io/badge/Deployed%20on-GitHub%20Pages-89216B.svg)
4+
5+
**English Name**: StarScope
6+
**Chinese Name**: 星探 (Xīng Tàn)
7+
8+
A hand-curated list of trending GitHub projects, updated daily and presented in minimal style.
9+
10+
🌐 **Live Site**: [StarScope](https://github-stars.xjmunity.com/)
11+
12+
---
13+
14+
## 📖 Project Overview
15+
16+
Among the thousands of new repositories on GitHub every day, truly remarkable "rising stars" often vanish unnoticed. Algorithm-driven recommendations may overlook niche yet brilliant projects — only human curation can capture those that are genuinely interesting, promising, and full of stories.
17+
18+
**StarScope** is exactly that: a human-powered discovery platform for exceptional open-source projects.
19+
20+
Curated daily by a developer passionate about uncovering hidden gems, each entry is personally reviewed, selected, and refined from the fastest-growing, most-starred, and most-talked-about new GitHub projects — then presented in a clean, elegant, and archivable format.
21+
22+
🔍 **Human-Curated**: No algorithms. Only thoughtful human judgment.
23+
📅 **Daily Updates**: One “open-source evening paper” every day — never miss a highlight.
24+
🌐 **Bilingual Support**: Content available in both Chinese and English; interface auto-redirects.
25+
🗂️ **Complete Archive**: Browse recommendations by day or month.
26+
🎨 **Minimalist Design**: Focus on content — no tracking, no distractions.
27+
28+
This is not a data aggregator — it's a developer’s open-source playbook.
29+
30+
---
31+
32+
## 🎯 Core Features
33+
34+
**Hand-Picked Curation**
35+
Every project is manually read, evaluated, and polished for quality and readability.
36+
37+
🌐 **Bilingual Interface**
38+
All pages support Chinese and English, with automatic language redirection via `root_index.html`.
39+
40+
📅 **Timeline Archive**
41+
Full historical archive organized by month, showing daily highlights at a glance.
42+
43+
🌙 **Dark Mode Support**
44+
Toggle between dark and light themes — your preference is saved locally.
45+
46+
🧱 **Fully Static Deployment**
47+
Hosted on GitHub Pages — zero server cost, ultra-lightweight.
48+
49+
🔓 **Open Source & Reusable**
50+
All code, templates, and data are publicly available. Contributions and forks welcome!
51+
52+
---
53+
54+
## 🖼️ Preview Screenshots
55+
56+
**Homepage (Today's Picks)**
57+
![Home Page Preview](https://via.placeholder.com/800x400?text=Home+Page+Preview)
58+
Highlights trending projects with star growth, programming language, and "New Project" tags.
59+
60+
**Archive Page**
61+
![Archive Page Preview](https://via.placeholder.com/800x400?text=Archive+Page+Preview)
62+
Monthly timeline with clear daily entry counts.
63+
64+
**About Page**
65+
![About Page Preview](https://via.placeholder.com/800x400?text=About+Page+Preview)
66+
Explains the philosophy behind human curation.
67+
68+
💡 *Replace placeholder links with actual screenshot URLs before release.*
69+
70+
---
71+
72+
## 🛠️ Tech Stack
73+
74+
StarScope uses a **"human input + static generation"** workflow, with a clean and transparent tech stack:
75+
76+
| Layer | Technology |
77+
|-------------------|-------------------------------------------------|
78+
| Frontend | HTML5, CSS3, Vanilla JavaScript |
79+
| Template Engine | Jinja2 (Python) |
80+
| Build Script | `build.py` (Python) |
81+
| Styling | Native CSS + `:root` variables + responsive layout |
82+
| Multilingual | JSON translation files + template injection |
83+
| Deployment | GitHub Pages (`gh-pages` branch or `/docs`) |
84+
| SEO Optimization | `sitemap.xml`, `og:` meta tags, `hreflang` |
85+
86+
---
87+
88+
## 🗂️ Project Structure
89+
```bash
90+
star-scope/
91+
├── build.py # Static site generator (Jinja2)
92+
├── data/ # Manually curated daily data
93+
│ ├── en/ # English JSON data
94+
│ └── zh/ # Chinese JSON data
95+
├── templates/ # HTML templates (Jinja2)
96+
├── static/ # Assets (CSS, JS)
97+
├── translations/ # Site-wide text translations
98+
├── output/ # Build output (for deployment)
99+
└── README.md # This file (Chinese)
100+
└── README_en.md # English version (this file)
101+
```
102+
103+
---
104+
## 🌍 How to View in Chinese
105+
To view the **Chinese version of this README**, please visit the repository directly on GitHub — this `README.md` is the default and primary file.
106+
👉 The Chinese `README.md` will always be the main landing file.
107+
🌐 You can also visit the live site: [https://github-stars.xjmunity.com/](https://github-stars.xjmunity.com/) — it supports **auto language detection and switching**.
108+
109+
---
110+
## 🤝 Contributions
111+
Welcome! Whether it's fixing typos, improving templates, or suggesting better curation workflows — all contributions are appreciated.
112+
Just open an issue or submit a pull request.
113+
114+
---
115+
## 📄 License
116+
MIT License. See [LICENSE](LICENSE) for details.

static/images/en/Archive.png

28.7 KB
Loading

static/images/en/about.png

136 KB
Loading

static/images/en/homepage.png

158 KB
Loading

static/images/zh/Archive.png

28.4 KB
Loading

static/images/zh/about.png

174 KB
Loading

static/images/zh/homepage.png

191 KB
Loading

0 commit comments

Comments
 (0)