Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

simplify README to make commands clear #273

Merged
merged 1 commit into from
Apr 5, 2016
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 9 additions & 3 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,8 @@ Install-Module posh-git
Installing (manual)
-------------------

**Pre-requisites:**

0. Verify you have PowerShell 2.0 or better with `$PSVersionTable.PSVersion`. PowerShell 3.0 is preferred as 2.0 support is deprecated.

1. Verify execution of scripts is allowed with `Get-ExecutionPolicy` (should be `RemoteSigned` or `Unrestricted`). If scripts are not enabled, run PowerShell as Administrator and call `Set-ExecutionPolicy RemoteSigned -Scope CurrentUser -Confirm`.
Expand All @@ -38,11 +40,15 @@ Installing (manual)
If the command is not found, you will need to add a git alias or add `%ProgramFiles(x86)%\Git\cmd`
(or `%ProgramFiles%\Git\cmd` if you're still on 32-bit) to your `PATH` environment variable.

3. Clone the posh-git repository to your local machine.
Then do this:

4. From the posh-git repository directory, run `.\install.ps1`.
```
git clone https://github.com/dahlbyk/posh-git.git
cd posh-git
.\install.ps1
```

5. Enjoy!
And you're set!

The Prompt
----------
Expand Down