Skip to content

Commit

Permalink
Update initialization instructions in README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Limych committed Jun 3, 2022
1 parent dd5d741 commit 2bcd243
Showing 1 changed file with 17 additions and 5 deletions.
22 changes: 17 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,17 @@ File | Purpose

## How?

* …or [use this template](https://github.com/Limych/ha-blueprint/generate) to create your new repository.
Then download a copy of the new repository to your IDE and run the final environment setup commands:
```bash
# Configure future updates from blueprint repository
git remote add blueprint https://github.com/Limych/ha-blueprint.git
git fetch blueprint dev

# Initialize the development environment
./bin/setup
```

* …or create a new repository on the command line:
```bash
# Initialize your new origin repository
Expand All @@ -68,6 +79,9 @@ File | Purpose

# Push changes to origin repository
git push -u origin dev

# Initialize the development environment
./bin/setup
```

* …or apply blueprint to an existing repository from the command line:
Expand All @@ -79,6 +93,9 @@ File | Purpose

# Push changes to origin repository
git push -u origin dev

# Initialize the development environment
./bin/setup
```

After these steps, your repository will developing on a own branch. But in parallel there will be this blueprint repository, new changes in which you can always apply with a couple of simple commands:
Expand All @@ -87,11 +104,6 @@ After these steps, your repository will developing on a own branch. But in paral
git merge blueprint/dev
```

**Note:** Please, before starting to develop your own code, initialize the development environment with the command
```bash
./bin/setup
```

If you want to use all the potential and features of this blueprint template you
should use devcontainer. See [.devcontainer/README.md](./.devcontainer/README.md) for more information.

Expand Down

0 comments on commit 2bcd243

Please sign in to comment.