From faa99ead3125cbffd14132516413a540b67bd252 Mon Sep 17 00:00:00 2001 From: Justin Denton Date: Wed, 24 Jul 2019 13:49:55 -0600 Subject: [PATCH] Corrections to installation instructions --- README.md | 24 ++++++++++++++---------- 1 file changed, 14 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 58b1415..7965e56 100644 --- a/README.md +++ b/README.md @@ -14,16 +14,20 @@ Adds settings for... * Tabs, spaces, and ruler ## Installation -1. Ensure the .vscode folder exists at the root of the project. Note that the .vscode folder is hidden and may need to be created. ```\opensphere\.vscode``` +Note: Snippets must ***not*** be located in a subfolder to .vscode; if they are they won't work. Cloning in a way that results in ```.vscode/opensphere-tests-vscode/*snippet_files*``` existing, will not work. Expected: ```/opensphere/.vscode/*snippet_files*``` + +Choose ONE option below: + +* To clone from project root and create the .vscode folder at the same time: + cd to /opensphere + + git clone https://github.com/justin-bits/opensphere-tests-vscode.git .vscode + +* To create the .vscode folder, then clone from within the folder: + mkdir .vscode - -2. Clone this repository directly to the .vscode folder in the project. Snippets must ***not*** be located in a subfolder to .vscode; if they are they won't work. - * To clone from project root - - git clone https://github.com/justin-bits/opensphere-tests-vscode.git - - * To clone from within ```.vscode``` - - git clone https://github.com/justin-bits/opensphere-tests-vscode.git . \ No newline at end of file + cd .vscode + + git clone https://github.com/justin-bits/opensphere-tests-vscode.git . \ No newline at end of file