rearrange src and add readme

1 files changed, 38 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..0716dff
--- /dev/null
+++ b/README.md
@@ -0,0 +1,38 @@
+# README for logout-manager
+## Introduction
+Logout Manager is a python3 utility that provides a simple menu for logout-type actions. The supported actions are presented:
+ * Lock
+ * Logout
+ * Hibernate (if supported by hardware)
+ * Shutdown
+ * Reboot
+
+## Alternatives
+[oblogout](https://launchpad.net/oblogout) looks really old so I did not investigate personally, but it sounds like it does the same thing I am trying to do.
+`apt-cache search logout` shows [lxsession-logout](http://manpages.ubuntu.com/manpages/precise/en/man1/lxsession-logout.1.html) which was compiled, as well as does not provide configurable options for changing executed commands or icons.
+
+## License
+[logout-manager-ncurses.py](src/usr/bin/logout-manager-ncurses.py) is licensed under the [MIT license](http://choosealicense.com/licenses/mit) and is derived almost entirely from [adamlamers](http://adamlamers.com/post/FTPD9KNRA8CT).
+Everything else is licensed under [CC-BY-SA 4.0](https://choosealicense.com/licenses/cc-by-sa-4.0/).
+
+## Description
+This project is partially a programming playground for the [original author](https://bgstack15.wordpress.com) and partially a useful project for his migration to [Fluxbox](http://fluxbox.org/) on the desktop.
+
+## Upsides
+* This project is the first to [demonstrate SVG images in tkinter in python3](https://bgstack15.wordpress.com/2019/07/13/display-svg-in-tkinter-python3/) that I could find on the Internet.
+* I have learned how to work with ncurses, gtk, and tcl in python3.
+* This will make Fluxbox systems easier to use for general users.
+
+## Downsides
+This whole thing is more complex than just logging out of my user session, and selecting a logout-type action from the display manager.
+
+## Improve
+* add makefile
+  * add the standard 'list' option
+  * add a `list_dependencies` option or similar, which does the grep command
+
+    grep -h -A5 -riIE dependencies * | awk 'tolower($0) ~ /devuan/ {$1="";$2="";print}' | sort | uniq | xargs
+
+* add logout-manager-cli.py
+* add debian/ dir
+  * and dsc file