Skip to content

Commit

Permalink
Add instructions and a proper README
Browse files Browse the repository at this point in the history
  • Loading branch information
chimbori authored Aug 21, 2021
1 parent 954568b commit eb15c08
Showing 1 changed file with 23 additions and 1 deletion.
24 changes: 23 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,23 @@
# reset-android-studio
# Reset Android Studio

When Android Studio is upgraded, projects often fail to build for mysterious reasons. This script
can clear everything at one go, so you can start with a clean slate & minimize wasted time.

## How to use

1. Download and place this script somewhere on your local machine.
2. From the root of your Android Studio project, run it: `reset-android-studio-mac.sh`

## Frequently Asked Questions

### Is there a Linux or Windows equivalent?

Not yet, since I primarily develop on macOS. Please feel free to contribute alternate versions.

### Is there a way to do a dry run?

For the sake of simplicity, there is currently no option to do a dry run. If you know you need this,
just go ahead and run it.

I assume you have all your important source code under version control anyway, so if this deletes
something you wish it did not delete, you should be able to revert it from your source control.

0 comments on commit eb15c08

Please sign in to comment.