Skip to content

Commit

Permalink
Update README with multi-OS setup instructions for the setup script
Browse files Browse the repository at this point in the history
  • Loading branch information
nabinkhair42 authored Feb 18, 2025
1 parent d687e21 commit 02bdbf0
Showing 1 changed file with 48 additions and 13 deletions.
61 changes: 48 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,24 +24,59 @@ This script creates a complete project structure with all necessary configuratio
- Bash shell
- Basic command line knowledge

Here's the updated version of your instructions in a clean, professional format for a repository README:

---

## Usage

1. Download the setup script:
```bash
curl -O https://raw.githubusercontent.com/nabinkhair42/mern-stater-kit/main/setup.sh
```
### 1. Download the Setup Script

2. Make the script executable:
```bash
chmod +x setup.sh
```
#### **Windows (PowerShell)**
```powershell
Invoke-WebRequest -Uri "https://raw.githubusercontent.com/nabinkhair42/mern-stater-kit/main/setup.sh" -OutFile "setup.sh"
```
Or, if `curl` is installed:
```powershell
curl.exe -O https://raw.githubusercontent.com/nabinkhair42/mern-stater-kit/main/setup.sh
```

3. Run the script:
```bash
./setup.sh
```
#### **macOS & Linux (Terminal)**
```bash
curl -O https://raw.githubusercontent.com/nabinkhair42/mern-stater-kit/main/setup.sh
```

### 2. Make the Script Executable

#### **macOS & Linux**
```bash
chmod +x setup.sh
```

#### **Windows (Git Bash, WSL, or PowerShell with Ubuntu Subsystem)**
```bash
chmod +x setup.sh
```
*(PowerShell does not require this step.)*

### 3. Run the Script

#### **macOS & Linux**
```bash
./setup.sh
```

#### **Windows (PowerShell)**
```powershell
bash setup.sh
```
*(Requires WSL, Git Bash, or a compatible shell.)*

### 4. Enter the Project Name

When prompted, enter your project name or press **Enter** to use the default name.

4. Enter your project name when prompted (or press Enter to use the default name)
---

## Generated Structure

Expand Down

0 comments on commit 02bdbf0

Please sign in to comment.