chore: update README files from the old nuxt branch

SkyBird233 · SkyBird233 · commit 4a96995a9bc1 · 2025-07-31T14:22:31.000+08:00
diff --git a/README.md b/README.md
@@ -1,75 +1,90 @@
-# Nuxt 3 Minimal Starter
+AOSC Portal
+===
 
-Look at the [Nuxt 3 documentation](https://nuxt.com/docs/getting-started/introduction) to learn more.
+[简体中文自述文件 >>](/README.zh-cn.md)
 
-## Setup
+The Portal website for AOSC since 2024 (designed in 2023, hence the name),
+built using Vue.js.
 
-Make sure to install the dependencies:
+At a glance
+---
 
-```bash
-# npm
-npm install
+The main design goal for this new website is to maximise information density
+on a single screen space, utilising both multi-column and conventional
+navigation systems. It also seeks to depart from a conventional "FOSS
+community" aesthetic by emphasizing vivid and product-oriented presentation
+for prospective and current users.
 
-# pnpm
-pnpm install
+In terms of visual styling, this website intentionally seeks to re-create a
+2000s Web 1.0 aesthetic (whilst adopting modern technological frameworks and
+layout optimisations). Inspiration for the site layout comes from Microsoft's
+Windows home page from 2001 - 2004:
 
-# yarn
-yarn install
+- [Reference 1, Windows XP home from late 2001](https://web.archive.org/web/20011211230629/http://microsoft.com/windowsxp/default.asp)
+- [Reference 2, Windows XP mid-cycle home from 2004](https://web.archive.org/web/20040204080626/http://www.microsoft.com/china/windows/default.mspx)
 
-# bun
-bun install
-```
-
-## Development Server
+Technically speaking, this a server-side rendered site built with Nuxt.
 
-Start the development server on `http://localhost:3000`:
+This website is not yet optimised for mobile, legacy (Afterglow-targeted),
+and functionally-limited browsers. We are currently evaluating plans to
+implement a purpose-specific site to help with these scenarios.
 
-```bash
-# npm
-npm run dev
+Deployment and testing
+---
 
-# pnpm
-pnpm run dev
+This website is deployed to our Web server using a GitHub workflow. It should
+also be deployed in conjunction with [website-2023-utils](https://github.com/AOSC-Dev/website-2023-utils).
+Please follow also the instructions there.
 
-# yarn
-yarn dev
+To test the website locally, you would need a Node.js + NPM toolchain and a
+deployment of the aforementioned [website-2023-utils](https://github.com/AOSC-Dev/website-2023-utils).
+To install Node.js + NPM on AOSC OS:
 
-# bun
-bun run dev
+```
+oma install nodejs
 ```
 
-## Production
-
-Build the application for production:
+Then, build and serve the website locally:
 
-```bash
-# npm
+```
 npm run build
+node .output/server/index.mjs
+```
 
-# pnpm
-pnpm run build
+Submitting news
+---
 
-# yarn
-yarn build
+All news articles are written in Markdown and stored in `/content/news`, with
+extra assets (images, etc.) stored in `/assets/...`. All assets should be
+referenced from the site (`/assets/...`, not `https://...`).
 
-# bun
-bun run build
-```
+News articles should contain a header:
 
-Locally preview production build:
+```
+---
+categories:
+  - journals
+title: "安记冰室・九月上"
+date: 2024-09-19T23:00:00+08:00
+important: false
+home: true
+---
+```
 
-```bash
-# npm
-npm run preview
+- `categories` (enum):
+    - `advisories`: User advisories (usually AOSC OS-related).
+    - `news`: Community news about events, sponsorships, etc.
+    - `journals`: Community journals (entitled *Coffee Break*).
+    - `minutes`: Contributor meeting records.
+- `title` (string): News title.
+- `date` (string): Publication date to be presented as-is.
+- `important` (boolean): Highlight as important.
+- `home` (boolean): Whether to list in the news highlight section at the Portal home.
 
-# pnpm
-pnpm run preview
+### Localising news articles
 
-# yarn
-yarn preview
+To localise a news article, use a language code suffix such as `.zh-cn`, i.e.:
 
-# bun
-bun run preview
 ```
-
-Check out the [deployment documentation](https://nuxt.com/docs/getting-started/deployment) for more information.
+2024-09-18-aosc-os-relnote.zh-cn.md
+```
diff --git a/README.zh-cn.md b/README.zh-cn.md
@@ -0,0 +1,74 @@
+安同开源社区门户网站 (AOSC Portal)
+===
+
+[英文自述文件 >>](/README.md)
+
+本仓库存放自 2024 年末启用的社区门户网站（设计稿 2023 年完成，故此得名）。本网站使用 Vue.js 构建。
+
+简述
+---
+
+本门户网站的主要设计目标是在单屏幕空间中显示尽可能多的有用信息，其主要实现手段是综合使用多列布局及纵横导航部件。此外，本门户网站还尝试摆脱 FOSS 社区网站的一些常见设计导向，采取图文混编、产品导向为主要呈现逻辑，方便新老用户了解社区项目、活动及公告等。
+
+外观设计方面，本门户网站有意地模仿了来自 2000 年代的 Web 1.0 审美（但从布局及技术上依然采用了现代技术）。本网站的布局灵感来源于 2001 - 2004 年间的微软 Windows 主页：
+
+- [参考甲：Windows XP 主页（2001 年末）](https://web.archive.org/web/20011211230629/http://microsoft.com/windowsxp/default.asp)
+- [参考乙：Windows XP 中期主页（2004 年）](https://web.archive.org/web/20040204080626/http://www.microsoft.com/china/windows/default.mspx)
+
+技术架构方面，该网站是使用 Nuxt 构建，采用服务端渲染技术。
+
+目前网站亦未对移动端、低性能（星霞 OS 目标）设备及功能受限的浏览器优化，我们计划在后续研判是否通过实现专用网站解决此问题。
+
+部署及测试
+---
+
+本网站使用 GitHub workflow 自动部署到我们的网站服务器，搭配 [website-2023-utils](https://github.com/AOSC-Dev/website-2023-utils) 一同使用（请注意阅读该仓库中的部署指南）。
+
+本地测试时，您需要安装 Node.js + NPM 工具链，安同 OS 用户可使用如下命令安装；您也需要部署 [website-2023-utils](https://github.com/AOSC-Dev/website-2023-utils)：
+
+```
+oma install nodejs
+```
+
+而后，使用如下命令启动网站构建及服务：
+
+```
+npm run build
+node .output/server/index.mjs
+```
+
+提交新闻
+---
+
+本站新闻使用 Markdown 格式编写，存放于 `/content/news`；额外文件（如图片等）存放于 `/assets/...`。引用额外文件时，应使用站内引用（`/assets/...`）而非站外引用（`https://...`）。
+
+新闻文件均带有文件头，如下例：
+
+```
+---
+categories:
+  - journals
+title: "安记冰室・九月上"
+date: 2024-09-19T23:00:00+08:00
+important: false
+home: true
+---
+```
+
+- `categories`（枚举值）：
+    - `advisories`：用户公告（一般与安同 OS 有关）
+    - `news`：社区活动新闻、赞助方鸣谢及公告等
+    - `journals`：社区期刊（《安记冰室》）
+    - `minutes`：贡献者会议纪要
+- `title`（字符串）：新闻标题
+- `date`（字符串）：用于网站呈现的发布日期
+- `important`（布尔值）：是否标记为重要新闻
+- `home`（布尔值）：是否在门户主页的要点栏目列出
+
+### 新闻本地化
+
+本地化新闻文章时，在文件名后加语言代号作为后缀即可（如 `.zh-cn`）：
+
+```
+2024-09-18-aosc-os-relnote.zh-cn.md
+```
