README.md

README.md

@@ -0,0 +1,90 @@
+# Checkpoint
+
+A minimal personal homepage built with Astro.
+
+This project is a lightweight public hub for:
+
+- a self-hosted Gitea instance
+- a GitHub mirror
+- gaming profiles for Steam, PlayStation, Xbox, and Nintendo Switch
+
+It is intentionally simple: one page, reusable Astro components, minimal JavaScript, and a dark, modern design.
+
+## Stack
+
+- [Astro](https://docs.astro.build/)
+- [Font Awesome Free](https://fontawesome.com/)
+- Plain CSS
+
+## Getting Started
+
+Install dependencies:
+
+```bash
+npm install
+```
+
+Start the development server:
+
+```bash
+npm run dev
+```
+
+Build for production:
+
+```bash
+npm run build
+```
+
+Preview the production build:
+
+```bash
+npm run preview
+```
+
+## Customization
+
+Most content lives in `src/data/links.ts`.
+
+Update this file to change:
+
+- hero title and subtitle
+- hostname/signature
+- Gitea and GitHub links
+- gaming profile links
+
+## Project Structure
+
+```text
+.
+├── public/
+│   └── favicon.svg
+├── src/
+│   ├── components/
+│   │   ├── Card.astro
+│   │   └── Section.astro
+│   ├── data/
+│   │   └── links.ts
+│   ├── layouts/
+│   │   └── Layout.astro
+│   ├── pages/
+│   │   └── index.astro
+│   └── styles/
+│       └── global.css
+├── .dockerignore
+├── .gitignore
+├── astro.config.mjs
+├── package.json
+├── README.md
+└── tsconfig.json
+```
+
+## Notes
+
+- The page is fully static and optimized for minimal client-side JavaScript.
+- Icons are provided through Font Awesome brand icons.
+- Styling is handled in `src/styles/global.css`.
+
+## License
+
+MIT