From b0be5de83a44a0a63f9edd42e944086b2b6906fa Mon Sep 17 00:00:00 2001 From: Juan Cruz Viotti Date: Mon, 21 Sep 2015 08:32:11 -0400 Subject: [PATCH] Add Troubleshooting guide This guide described common Resin CLI issues and how to fix them. --- README.md | 2 +- TROUBLESHOOTING.md | 15 +++++++++++++++ 2 files changed, 16 insertions(+), 1 deletion(-) create mode 100644 TROUBLESHOOTING.md diff --git a/README.md b/README.md index a9328e76..1b02d16c 100644 --- a/README.md +++ b/README.md @@ -53,7 +53,7 @@ Caveats Support ------- -If you're having any problem, please [raise an issue](https://github.com/resin-io/resin-cli/issues/new) on GitHub and the Resin.io team will be happy to help. +If you're having any problem, check our [troubleshooting guide](https://github.com/resin-io/resin-cli/blob/master/TROUBLESHOOTING.md) and if your problem is not addressed there, please [raise an issue](https://github.com/resin-io/resin-cli/issues/new) on GitHub and the Resin.io team will be happy to help. License ------- diff --git a/TROUBLESHOOTING.md b/TROUBLESHOOTING.md new file mode 100644 index 00000000..f7de0608 --- /dev/null +++ b/TROUBLESHOOTING.md @@ -0,0 +1,15 @@ +Troubleshooting +=============== + +This document contains common issues related to the Resin CLI, and how to fix them. + +### After burning to an sdcard, my device doesn't boot + +- The downloaded image is not complete (download was interrupted). + +Please clean the cache (`%HOME/.resin/cache` or `C:\Users\\_resin\cache`) and run the command again. In the future, the CLI will check that the image is not complete and clean the cache for you. + +### I get a permission error when burning to an sdcard + +- The SDCard is locked. +- The burning operation is not 100% reliable in Windows 10. We're working on it at the moment.