From f220d9b3da1b06b55580616323fa7f9f8a7df475 Mon Sep 17 00:00:00 2001 From: Mumtahin Farabi Date: Wed, 19 Jun 2024 19:40:20 -0400 Subject: [PATCH] docs: Update README --- README.md | 33 ++++++++++++++++++--------------- 1 file changed, 18 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index c403366..a56a625 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,22 @@ This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next ## Getting Started +Clone the repository: + +```bash + +git clone https://github.com/SPAC-2024/2024-ieee-spac-website.git + +``` + +Install packages: + +```bash + +npm i + +``` + First, run the development server: ```bash @@ -16,21 +32,8 @@ bun dev Open [http://localhost:3000](http://localhost:3000) with your browser to see the result. -You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file. - -This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font. - -## Learn More - -To learn more about Next.js, take a look at the following resources: - -- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API. -- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial. - -You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome! - ## Deploy on Vercel -The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js. +This project is made using Next.js, and can easily be deployed on the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.j. -Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details. +Check out the [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.