Skip to content

Commit 8727f69

Browse files
Fix README styling (#82)
1 parent 3313827 commit 8727f69

File tree

1 file changed

+20
-11
lines changed

1 file changed

+20
-11
lines changed

README.md

Lines changed: 20 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -8,47 +8,56 @@
88

99
:books: **Features** of our project include a dynamic and responsive user interface powered by NextJS & React, stylish components with Tailwind CSS, and smooth animations and transitions through Framer Motion to enhance the user experience.
1010

11-
🚀 **Getting Started**
11+
## 🚀 Getting Started
1212

1313
To contribute to this project, follow these steps:
1414

1515
**1. Fork the Repository**: Click the "Fork" button at the top right corner of this repository's page. This will create a copy of the project in your GitHub account.
16+
1617
**2. Clone Your Fork**: Now, you need to clone your forked repository to your local machine. Replace [your-username] with your GitHub username in the URL below:
1718

18-
```Node
19+
```bash
1920
git clone https://github.com/[your-username]/website.git
2021
```
2122

2223
**3. Navigate to the project directory**:
2324

24-
```Node
25+
```bash
2526
cd website
2627
```
2728

28-
**4. Install the dependencies**:
29+
**4. Set the NodeJS version**:
30+
31+
You can utilize [nvm](https://github.com/nvm-sh/nvm) (Node Version Manager) to use the project's specific NodeJS version:
32+
33+
```bash
34+
nvm use
35+
```
36+
37+
**5. Install the dependencies**:
2938

30-
```Node
39+
```bash
3140
npm install
3241
```
3342

34-
**5. Start the development server**:
43+
**6. Start the development server**:
3544

36-
```Node
45+
```bash
3746
npm run dev
3847
```
3948

40-
**6. Run linter**:
49+
**7. Run linter**:
4150

42-
```Node
51+
```bash
4352
npm run lint
4453
```
4554

4655
Now you're ready to contribute. Make your changes, commit them, and then create a **pull request** to submit your contributions. Thank you for contributing to CodeWithAloha!
4756

48-
:clipboard: **License**
57+
## :clipboard: License
4958

5059
This project is licensed under the MIT License.
5160

52-
:speech_balloon: **Contact**
61+
## :speech_balloon: Contact
5362

5463
For inquiries and feedback, please reach out to [[email protected]](mailto:[email protected]).

0 commit comments

Comments
 (0)