Skip to content

Commit

Permalink
adds git-remote instructions to the readme
Browse files Browse the repository at this point in the history
  • Loading branch information
rogerlz committed Dec 12, 2023
1 parent 4380146 commit 7c7b2f0
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 4 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,4 @@ ci_cache/
_test_.*
klippy/plugins/*
!klippy/plugins/__init__.py
.vscode
24 changes: 20 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ If you're feeling adventurous, take a peek at the extra features in the bleeding
- [input_shaper: smooth input shapers](https://github.com/DangerKlippers/danger-klipper/pull/69)

- [input_shaper: new print_ringing_tower utility](https://github.com/DangerKlippers/danger-klipper/pull/69)

## Switch to Danger Klipper
> [!NOTE]
> Any add-on modules you are using will need to be reinstalled after switching to Danger Klipper. This includes things like Beacon support, led-effect, etc.
Expand All @@ -74,23 +74,28 @@ If you're feeling adventurous, take a peek at the extra features in the bleeding
### Manually clone the repository
If desired, make a backup copy of your existing Klipper installation by running:
```

```bash
mv ~/klipper ~/klipper_old
```

Then clone the Danger Klipper repo and restart the klipper service:
```

```bash
git clone https://github.com/DangerKlippers/danger-klipper.git ~/klipper
sudo systemctl restart klipper
```

### Using KIAUH
For users that are not comfortable using Git directly, [KIAUH](https://github.com/dw-0/kiauh) is able to use custom repositories.

To do this, add the Danger Klipper repo to KIAUH's repo list and run the script with the following commands:

```
```bash
echo "DangerKlippers/danger-klipper" >> ~/kiauh/klipper_repos.txt
~/kiauh/kiauh.sh
```

From the KIAUH menu select:
- 6 ) Settings
- 1 ) Set custom Klipper repository
Expand All @@ -99,6 +104,17 @@ From the KIAUH menu select:
- Enter 'B' for back twice
- 'Q' to quit

### Adding a git-remote to the existing installation
```bash
cd ~/klipper
git remote add danger https://github.com/DangerKlippers/danger-klipper.git
git checkout -b upstream-master origin/master
git branch -D master
git checkout -b master danger/master
sudo systemctl restart klipper
sudo systemctl restart moonraker
```

---
"Dangerous Klipper for dangerous users"

Expand Down

0 comments on commit 7c7b2f0

Please sign in to comment.