Skip to content

Commit

Permalink
Update documentation frontpage
Browse files Browse the repository at this point in the history
  • Loading branch information
miklschmidt committed Jul 18, 2021
1 parent c82052c commit 92612a6
Showing 1 changed file with 3 additions and 12 deletions.
15 changes: 3 additions & 12 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,19 +3,10 @@ V-CoreOS is a preconfigured software package for the Rat Rig V-Core 3, that aims

To run V-CoreOS on your V-Core 3 you need a supported control board and a Raspberry Pi. The initial configuration is made to work with the official [SKR Pro 1.2 Wiring Diagram](https://v-core.ratrig.com/electronics/#skr-pro-12).

# Contribute
Join the discussion on discord!


# Troubleshooting
If klipper won't connect, try restarting your raspberry pi. Make sure the SKR Pro is connected to the Pi via USB, that both are powered, and that the firmware.bin has been properly flashed. You can verify the last part by checking if the firmware.bin file has been changed to firmware.CUR on the SD card. If you have trouble flashing the motherboard (a green light should flash while booting, indicating the firmware has been flashed succefully), try disconnecting your endstops, if these are wired incorrectly the board will not boot properly.

If any of your axes are inverted, tripple check your wiring. It's important to note that this config is made specifically for the SKR Pro 1.2 and the 48mm LDO's that ship optionally with the V-Core 3. For other steppers, you'll have to check the stepper pinout and potentially move pins on your cable, or you can override the stepper dir_pins as needed in your printer.cfg after the steppers.cfg file has been included, like so:
```
[stepper_x]
dir_pin: PF1
```

For further support check out the v-coreos and klipper channels on the [Unnofficial RatRig Discord Community](https://v-core.ratrig.com/community/#unofficial-community-on-discord).

<a href="https://discord.gg/D62e8XNeYa" class="button">Join the Unnofficial RatRig Discord Community</a>
# Software Credits

V-CoreOS is based on [Klipper](https://www.klipper3d.org/), [Fluidd](https://docs.fluidd.xyz/), [MainsailOS](https://github.com/raymondh2/MainsailOS) and [FluiddPi](https://github.com/cadriel/FluiddPI), without these and the amazing people behind them, V-CoreOS would not have been possible.

0 comments on commit 92612a6

Please sign in to comment.