Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
WilliamVenner committed Jan 27, 2024
1 parent c54b59a commit 2db5dc6
Showing 1 changed file with 7 additions and 17 deletions.
24 changes: 7 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,31 +26,21 @@ _And much more..._

[Click here](https://github.com/WilliamVenner/blackhole/releases) for pre-built binaries.

## Requirements

* Your operating system must have some form of "Recycle Bin" or "Trash"
* Your operating system must provide you a home directory
* The program may require administrative/elevated privileges on some operating systems

## Windows

Blackhole will automatically add itself to your startup programs via the registry.

If contents are present, the `BLACKHOLE` directory will be moved to the Recycle Bin every time you start up your computer.

The `BLACKHOLE` directory will automatically be added to the Quick Access locations.
* Blackhole will automatically add itself to your startup programs via the registry.
* The `BLACKHOLE` directory will be moved to the Recycle Bin every time you login, if contents are present.
* The `BLACKHOLE` directory will automatically be added to the Quick Access locations.

#### File Location

`%USERPROFILE%/BLACKHOLE`

## Linux & MacOS

Automatically scheduling the Blackhole to be purged at startup is currently only supported on macOS.

If you know Rust and a bit about your favourite OS, pull requests are appreciated.
## macOS

If you simply want to do it yourself, just run the program with the `--purge` flag at startup.
* Blackhole will automatically add itself to your login items when you first run the program.
* The `BLACKHOLE` directory will be moved to the Trash every time you login, if contents are present.
* The `BLACKHOLE` directory will automatically be added to the Finder sidebar.

#### File Location

Expand Down

0 comments on commit 2db5dc6

Please sign in to comment.