docs: update README with project-specific content

This commit is contained in:
Claude 2026-01-19 06:42:26 +00:00
parent d19624b459
commit 2d3e505b21
No known key found for this signature in database

View file

@ -1,46 +1,59 @@
# Astro Starter Kit: Basics
# AeThex
Infrastructure for the Metaverse.
## About
AeThex provides foundational infrastructure for building immersive digital experiences. The platform is organized into three divisions:
- **Foundation** - Open-source tools and community governance
- **Corporation** - Commercial products and enterprise services
- **Labs** - Research & development for experimental technologies
## Tech Stack
- [Astro](https://astro.build) - Static site generator
- CSS with custom properties and animations
- Responsive design with mobile-first breakpoints
## Project Structure
```sh
npm create astro@latest -- --template basics
```
> 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun!
## 🚀 Project Structure
Inside of your Astro project, you'll see the following folders and files:
```text
/
├── public/
│ └── favicon.svg
├── src
│   ├── assets
│   │   └── astro.svg
│   ├── components
│   │   └── Welcome.astro
│   ├── layouts
│   │   └── Layout.astro
│   └── pages
│   └── index.astro
│ └── global.css # Global styles
├── src/
│ ├── components/ # Reusable UI components
│ ├── layouts/
│ │ └── MainLayout.astro
│ └── pages/
│ ├── index.astro # Homepage
│ ├── foundation.astro
│ ├── corporation.astro
│ ├── labs.astro
│ ├── products.astro
│ ├── community.astro
│ ├── docs.astro
│ └── about.astro
└── package.json
```
To learn more about the folder structure of an Astro project, refer to [our guide on project structure](https://docs.astro.build/en/basics/project-structure/).
## Development
## 🧞 Commands
```sh
# Install dependencies
npm install
All commands are run from the root of the project, from a terminal:
# Start dev server
npm run dev
| Command | Action |
| :------------------------ | :----------------------------------------------- |
| `npm install` | Installs dependencies |
| `npm run dev` | Starts local dev server at `localhost:4321` |
| `npm run build` | Build your production site to `./dist/` |
| `npm run preview` | Preview your build locally, before deploying |
| `npm run astro ...` | Run CLI commands like `astro add`, `astro check` |
| `npm run astro -- --help` | Get help using the Astro CLI |
# Build for production
npm run build
## 👀 Want to learn more?
# Preview production build
npm run preview
```
Feel free to check [our documentation](https://docs.astro.build) or jump into our [Discord server](https://astro.build/chat).
## License
© 2026 AeThex