From 5a119da010c506c45c0dc0cbb68410571cdd7dba Mon Sep 17 00:00:00 2001 From: lksz Date: Fri, 2 Oct 2020 14:11:46 -0400 Subject: [PATCH] Better instructions --- README.md | 16 ++++++---------- 1 file changed, 6 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 2569fb0..47dd6b2 100644 --- a/README.md +++ b/README.md @@ -12,19 +12,15 @@ This envrionment can be installed using one the following options: iwr https://lksz.me/pwsz | iex ``` -This sets up the `$PROFILE` file, and initilizes the default dir, but nothing else is done. -Cloning the repo, is something you'll need to deal with on your own, or you can call the next line. +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`](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 [prefered] Short, but with control option +### The Short, but with control option ```PowerShell -$sfw=1; iwr https://lksz.me/pwsz | iex; _setup [-sudo] [-Force] [-GitClone] [-GitURL ] [-WhatIf] [-Confirm] [] +$sfw=1; iwr https://lksz.me/pwsz | iex; _setup [-sudo] [-Force] [-NoGitClone] [-GitURL ] [-WhatIf] [-Confirm] [] ``` -This will setup the `$PROFILE` file properly, and when the `-GitClone` switch is used, the git repo is cloned into `$MyPSScriptRoot`. +The key here is `$sfw=1`, which can be substitued with the more verbose `$SetupFromWeb=1`, this let's the [`Setup-Profile`](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 -Follow the instructions in the initial [blog post](https://blog.lksz.me/keeping-track-of-everything/#-mypsscriptroot) which contains the steps for cloning and using the env as your own. - -In the above one-liners, `https://lksz.me/pwsz` actually points to the [Setup-Profile.ps1] file, which means, that after you have the `Scripts` directory setup, you can all `Setup-Profile` to setup the `$PROFILE` file. - - +You can always clone the git repo first, and only then run the [`Setup-Profile.ps1`](Setup-Profile.ps1) script. \ No newline at end of file