diff --git a/README.md b/README.md index 15933646..6aee3614 100644 --- a/README.md +++ b/README.md @@ -6,26 +6,27 @@ This is the official repository for the University of Adelaide Computer Science ## Getting Started -To get started, first clone the repository and open the folder. +To get started, please follow these steps: +1. Clone the repository and open the folder. ```bash git clone https://github.com/compsci-adl/website cd website ``` -Next install the dependencies. +2. Install the dependencies. ```bash pnpm i ``` -Set up the keys by copying `.env.local.example` to a new file `.env.local` and replace the placeholder keys with the actual keys. Please contact the open source officers on the CS Club Discord to get these keys. +3. Set up the keys by copying `.env.local.example` to a new file `.env.local` and replace the placeholder keys with the actual keys. Please contact the open source officers on the CS Club Discord to get these keys. -Initialise the database +4. Initialise the database ```bash -pnpm run db:push +pnpm db:push ``` -Then run the development server +5. Then run the development server ```bash pnpm dev @@ -35,10 +36,4 @@ Open [http://localhost:3000](http://localhost:3000) with your browser to see the ## Contributing -We welcome contributions to enhance the CS Club Website! If you find any issues, have suggestions, or want to request a feature, please follow these guidelines: - -- Check the [Code Style Guide](docs/coding-style.md) to maintain consistency. -- Open an issue to report problems or discuss potential changes. -- Submit a pull request to propose fixes or improvements. - -For more details, check our [Contributing Guidelines](CONTRIBUTING.md). +We welcome contributions to enhance the CS Club Website! If you find any issues, have suggestions, or want to request a feature, please follow our [Contributing Guidelines](CONTRIBUTING.md).