updated README.md after renaming the setup script

This commit is contained in:
lksz 2021-06-22 00:22:58 -04:00
parent b8e123d447
commit b92f8fb9e8
1 changed files with 5 additions and 13 deletions

View File

@ -1,26 +1,18 @@
# PowerShell Scripts
These are the scripts that go into $MyPSScriptRoot which is part of my $env:PATH.
These are the scripts that go into `$MyPSScriptRoot` which is part of my `$env:PATH`.
The development of these is documented in my blog: https://blog.lksz.me
They are provided 'as is' for your review and for your reuse.
This envrionment can be installed using one the following options:
### The Short, yet safer way
### This is the way
Below are instrucitons for initializing/setting up this envrionment:
```PowerShell
iwr https://lksz.me/pwsz | iex
_Init # [-WriteInitScript] [-sudo] [-Force] [-NoGitClone] [-GitURL <alternative git URL>] [-WhatIf] [-Confirm] [<CommonParameters>]
```
This sets up the `$PROFILE` file, and initilizes the default dir `$MyPSScriptRoot` with a git clone of this repo.
The `https://lksz.me/pwsz` actually points to the [`Setup-Profile.ps1`](base/Setup-Profile.ps1) script, which means, that after you have the `Scripts` directory setup, you can call `Setup-Profile` to update the `$PROFILE` after the `Setup-Profile.ps1` has been modified (or updated via `git pull`).
The `https://lksz.me/pwsz` actually points to the [`Setup-ScriptEnv.ps1`](Setup-ScriptEnv.ps1) script, which means, that after you have the `Scripts` directory setup, you can call `Setup-ScriptEnv -WriteInitScript` to update the `$PROFILE` after the setup script has been modified (or updated via `git pull`).
### The somewhat Short, but with control option
```PowerShell
$sfw=1; iwr https://lksz.me/pwsz | iex; _setup [-sudo] [-Force] [-NoGitClone] [-GitURL <alternative git URL>] [-WhatIf] [-Confirm] [<CommonParameters>]
```
The key here is `$sfw=1`, which can be substitued with the more verbose `$SetupFromWeb=1`, this let's the [`Setup-Profile`](base/Setup-Profile.ps1) script know to just load it's content, but allow you to manually call it's internal function via `_setup`
### The 'I don't trust one liners, what's going on ?!?' option
You can always clone the git repo first, and only then run the [`Setup-Profile.ps1`](base/Setup-Profile.ps1) script.