diff options
| author | B Stack <bgstack15@gmail.com> | 2020-09-29 18:59:51 -0400 |
|---|---|---|
| committer | B Stack <bgstack15@gmail.com> | 2020-09-29 18:59:51 -0400 |
| commit | cdfc069c4181e83b62b411ecfcdcc936f65ea87e (patch) | |
| tree | e0242483023fa8ed498dac31a883196779fdb6be /README.md | |
| parent | add makefile, and MYA_PREFIX support to initialize.sh (diff) | |
| download | myautomount-cdfc069c4181e83b62b411ecfcdcc936f65ea87e.tar.gz myautomount-cdfc069c4181e83b62b411ecfcdcc936f65ea87e.tar.bz2 myautomount-cdfc069c4181e83b62b411ecfcdcc936f65ea87e.zip | |
write nice readme
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 23 |
1 files changed, 16 insertions, 7 deletions
@@ -1,13 +1,22 @@ -# Overview -Myautomount was translated to shell almost line-for-line from Go source at [https://github.com/project-trident/trident-utilities/blame/master/src-go/automount/main.go](https://github.com/project-trident/trident-utilities/blame/master/src-go/automount/main.go) but then it diverged. +# README for myautomount +## Overview +Myautomount is a solution for desktop users who want to have easy access to removable media, without dbus. Dependencies include autofs, python3, and gtk3. This package provides a system tray icon that displays the available removable media that can be mounted with autofs. -# TODO -write makefile -write better readme -write man pages +Myautomount is my response to the Go tool by Project Trident, [trident-automount][1]. I translated the Go tool almost line-for-line into shell, and then modified it slightly. -# TESTING AND BUILDING +## Design and architecture +A shell script, myautomountd, wraps around `udevadm monitor` to watch for block devices that are added and removed. Upon finding a new block device, the daemon will generate pseudo-xdg [desktop files][2] in a particular directory which defaults to `/run/user/${UID}/media`. +The tray icon uses a python implementation of [inotify][3] to watch that directory, and generate menus for the left- and right-click actions. + +## Testing and building myautomount +Build dependencies include txt2man, and my txtman-wrapper from [bgscripts-core][4]. Use environment variable `MYA_PREFIX` for testing. export MYA_PREFIX=~/dev/myautomount/src sudo DEBUG=1 MYA_PREFIX=~/dev/myautomount/src sh -x usr/libexec/myautomount/myautomount-initialize.sh + +# References +[1]: https://github.com/project-trident/trident-utilities/blame/master/src-go/automount/main.go +[2]: https://specifications.freedesktop.org/desktop-entry-spec/desktop-entry-spec-latest.html +[3]: https://github.com/seb-m/pyinotify +[4]: https://gitlab.com/bgstack15/bgscripts/-/blob/master/src/usr/bin/txt2man-wrapper |