From f268ca934a0daa706d5ed0dbbda7a7ee5602c569 Mon Sep 17 00:00:00 2001 From: Kamran Ahmed Date: Wed, 4 Jan 2023 20:17:40 +0400 Subject: [PATCH] Update readme --- README.md | 54 ++++++++++++++---------------------------------------- 1 file changed, 14 insertions(+), 40 deletions(-) diff --git a/README.md b/README.md index 8252739a4..6abf78c16 100644 --- a/README.md +++ b/README.md @@ -1,50 +1,24 @@ -# Welcome to [Astro](https://astro.build) +![](https://i.imgur.com/waxVImv.png) -[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/withastro/astro/tree/latest/examples/basics) -[![Open with CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/s/github/withastro/astro/tree/latest/examples/basics) +

You are probably looking for Developer Roadmap

-> 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun! +![](https://i.imgur.com/waxVImv.png) -![basics](https://user-images.githubusercontent.com/4677417/186188965-73453154-fdec-4d6b-9c34-cb35c248ae5b.png) +# next.roadmap.sh +WIP version of roadmap.sh built with [Astro](https://astro.build) and Tailwind. +## Development -## 🚀 Project Structure +Clone the repo and install dependencies: -Inside of your Astro project, you'll see the following folders and files: - -``` -/ -├── public/ -│ └── favicon.svg -├── src/ -│ ├── components/ -│ │ └── Card.astro -│ ├── layouts/ -│ │ └── Layout.astro -│ └── pages/ -│ └── index.astro -└── package.json +```bash +git clone git@github.com:kamranahmedse/roadmap.sh.git +pnpm install ``` -Astro looks for `.astro` or `.md` files in the `src/pages/` directory. Each page is exposed as a route based on its file name. +Run the project -There's nothing special about `src/components/`, but that's where we like to put any Astro/React/Vue/Svelte/Preact components. +```shell +pnpm run dev +``` -Any static assets, like images, can be placed in the `public/` directory. - -## 🧞 Commands - -All commands are run from the root of the project, from a terminal: - -| Command | Action | -| :--------------------- | :------------------------------------------------- | -| `npm install` | Installs dependencies | -| `npm run dev` | Starts local dev server at `localhost:3000` | -| `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 preview` | -| `npm run astro --help` | Get help using the Astro CLI | - -## 👀 Want to learn more? - -Feel free to check [our documentation](https://docs.astro.build) or jump into our [Discord server](https://astro.build/chat).