From 5be87951136dc62c0b2d8990740ac24efa0f9aa4 Mon Sep 17 00:00:00 2001 From: "Zed A. Shaw" Date: Wed, 1 Feb 2023 20:10:30 -0500 Subject: [PATCH] A bit more refined instructions in quick start. --- rendered/docs/quick-start.md | 23 ++++++++++++++++++++++- 1 file changed, 22 insertions(+), 1 deletion(-) diff --git a/rendered/docs/quick-start.md b/rendered/docs/quick-start.md index cdb0f67..73f1137 100644 --- a/rendered/docs/quick-start.md +++ b/rendered/docs/quick-start.md @@ -60,7 +60,8 @@ If you can't then refer to the documentation for `ljsthw-bandolier`, _especially If you can run the `npx bando-up` command then use it to create your first project: ```shell -npx bando-up create my-project +# see Next Steps at the end regargind --keep-git here +npx bando-up create --keep-git my-project ``` This will checkout the [Bandolier Template](https://git.learnjsthehardway.com/learn-javascript-the-hard-way/bandolier-template) git repository into the `my-project` directory. Once it's done you can move on to _Configuration_. @@ -329,4 +330,24 @@ npm run DANGER_ADMIN ## Next Steps +One final thing you'll want to do is either delete the `.git` directory and make your own git like this: + +```shell +# make sure you are in the my-project directory +pwd +# then remove .git and make your own +rm -rf .git +git init . +``` + +I suggest you also checkout the full `bandolier-template` for tracking updates like this: + +```shell +# get out of your my-project directory if cd .. doesn't +cd .. +npx bando-up create --keep-git bandolier-template +``` + +If you create other projects later then drop the `--keep-git` so you don't have to do this step. + This Quick Start is designed to only get you up and running and make sure the basic features are working.