Updating documentation.
Finished the README.md for real. It now inculuds instructions for recreating the .dmg and .app files.
This commit is contained in:
parent
51fbf15428
commit
d804270ac9
31
README.md
31
README.md
@ -1,6 +1,6 @@
|
||||
# Show Hidden
|
||||
|
||||
Shows or hides hidden files in mac finder.
|
||||
Shows or hides hidden files in mac finder. In old versions of OSX this isn't a feature of Finder.
|
||||
|
||||
It's a very basic shell script.
|
||||
Here's the full thing.
|
||||
@ -19,12 +19,14 @@ fi
|
||||
exit
|
||||
```
|
||||
|
||||
This script has been wrapped in a .dmg file for ease of use.
|
||||
|
||||
**[Note]:** *Only works on OSX.* It shouldn't damage anything if you run it on another system with bash installed but it won't do anything either.
|
||||
|
||||
## Requierments
|
||||
|
||||
A version of OSX around 10.6
|
||||
OSX 10.6.8 is the only thing this has been tested on. If you have a simi-modern version of OSX/macOS this functionality is now built into Files.
|
||||
OSX 10.6.8 is the only thing this has been tested on. If you have a simi-modern version of OSX/macOS this functionality is now built into Finder.
|
||||
|
||||
## Running
|
||||
|
||||
@ -40,4 +42,27 @@ Two methods of running are provided.
|
||||
|
||||
* Download the [.dmg](https://efrick.ddns.net/git/manfromhuh/ShowHidden/releases).
|
||||
* Open the .dmg and drag the application to the Applications folder.
|
||||
* Run from the application menu.
|
||||
* Run from the application menu
|
||||
|
||||
Or download the [.app](https://efrick.ddns.net/git/manfromhuh/ShowHidden/releases) and either manualy move to the Applications directory or run it from the
|
||||
|
||||
## The DMG
|
||||
If you want to recreate the .app file.
|
||||
|
||||
1. Open Automator.
|
||||
2. Select `Application` as the type.
|
||||
3. Find and drag `Run Shell Script` to the sequence.
|
||||
4. Copy and paste the contents of `show_hidden.sh` into the script window.
|
||||
5. Name and save in `Application` format.
|
||||
6. *[Optional]* To add a custom icon:
|
||||
i. Obtain the image you want to use.
|
||||
ii. Open in Preview.
|
||||
iii. Save as `AutomatorApplet.icns` being sure to select `ICNS` format.
|
||||
iv. Open the .app by right clicking and selecting `Show Package Contents`.
|
||||
v. Go to the `Contents/Resources` directory and replace the existing `AutomatorApplet.icns` file with your custom one.
|
||||
vi. Close the .app in Finder
|
||||
|
||||
If you want to recreate the .dmg file.
|
||||
|
||||
1. Follow the instructions [here](https://www.wikihow.com/Make-a-DMG-File-on-a-Mac) and add a symbolic link to the `Applications` folder.
|
||||
2. Or use a tool such as [create-dmg](https://github.com/create-dmg/create-dmg). I can vouch for this tool working on OSX 10.6 as of version [1.0.8](https://github.com/create-dmg/create-dmg/releases/tag/v1.0.8).
|
BIN
Show Hidden.app/Contents/Resources/rw.AutomatorApplet.icns.dmg
Normal file
BIN
Show Hidden.app/Contents/Resources/rw.AutomatorApplet.icns.dmg
Normal file
Binary file not shown.
BIN
Show Hidden.app/Contents/Resources/showhidden.png
Normal file
BIN
Show Hidden.app/Contents/Resources/showhidden.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 111 KiB |
BIN
ShowHidden.dmg
Executable file → Normal file
BIN
ShowHidden.dmg
Executable file → Normal file
Binary file not shown.
Loading…
x
Reference in New Issue
Block a user