Simplify README installation instructions
- Remove complex installation options - List prerequisites with direct winget commands - Keep oneshot installation as recommended option - Add manual setup steps for clarity - Focus on getting users started quickly
This commit is contained in:
47
README.md
47
README.md
@@ -77,30 +77,45 @@ Then run scripts using:
|
|||||||
|
|
||||||
## Requirements
|
## Requirements
|
||||||
|
|
||||||
### Installation
|
### Prerequisites
|
||||||
|
|
||||||
**Quick Automated Installation (Windows 11):**
|
Install these tools before starting:
|
||||||
|
|
||||||
|
**PowerShell 7+**
|
||||||
|
```powershell
|
||||||
|
winget install Microsoft.PowerShell
|
||||||
|
```
|
||||||
|
|
||||||
|
**Git 2.23+**
|
||||||
|
```powershell
|
||||||
|
winget install Git.Git
|
||||||
|
```
|
||||||
|
|
||||||
|
**Visual Studio Code**
|
||||||
|
```powershell
|
||||||
|
winget install Microsoft.VisualStudioCode
|
||||||
|
```
|
||||||
|
|
||||||
|
### Quick Start
|
||||||
|
|
||||||
**Option 1: Oneshot Installation (Recommended)**
|
**Option 1: Oneshot Installation (Recommended)**
|
||||||
Download, install prerequisites, and clone the repository in one command:
|
Install everything and clone the repository in one command:
|
||||||
|
|
||||||
```powershell
|
```powershell
|
||||||
irm https://git.frod.dk/floppydiscen/git-workshop/raw/branch/main/install.ps1 | iex
|
irm https://git.frod.dk/floppydiscen/git-workshop/raw/branch/main/install.ps1 | iex
|
||||||
```
|
```
|
||||||
|
|
||||||
This will:
|
**Option 2: Manual Setup**
|
||||||
- Install PowerShell 7, Git 2.23+, and Visual Studio Code
|
1. Install the prerequisites above
|
||||||
- Clone the git-workshop repository to `~/git-workshop`
|
2. Clone this repository:
|
||||||
- Leave you ready to start the first module
|
```powershell
|
||||||
|
git clone https://git.frod.dk/floppydiscen/git-workshop.git
|
||||||
**Option 2: Local Installation**
|
```
|
||||||
Clone the repository first, then run:
|
3. Configure Git:
|
||||||
|
```powershell
|
||||||
```powershell
|
git config --global user.name "Your Name"
|
||||||
.\install-prerequisites.ps1
|
git config --global user.email "your.email@example.com"
|
||||||
```
|
```
|
||||||
|
|
||||||
**Manual Installation:** See [INSTALLATION.md](INSTALLATION.md) for complete step-by-step installation instructions including PowerShell 7, Git, and Visual Studio Code.
|
|
||||||
|
|
||||||
**Quick Check:**
|
**Quick Check:**
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user