Converted docs to rst format

Split README into two docs: README.rst and TODO.rst. The todo file
contains bugs and features (moved bugs section from old readme file into
todo).

README contains new documentation detailing what andbackup does, usage,
and examples.

3 files changed, 100 insertions, 84 deletions

diff --git a/README b/README
deleted file mode 100644
index 48f5b6a..0000000
--- a/README
+++ /dev/null
@@ -1,84 +0,0 @@
--=TOC=-
--CYGWIN
--WINDOWS SHELL
--BASH
--TODO BUGS
-
-CYGWIN doesn't echo things properly.  Like when you hit up arrow instead of showing the last command it travels up in the window.  But it still will execute the last command upon hitting <enter>.  <tab> autocomplete also doesn't render but still executes.
-
-Here's sample output of how bad it is on cygwin:
----
-root@htc_himaul:/sdcard2/bk/andbackup # ./and   .
-./and
-andbackup.sh andbackup/
-/andbackup.sh                                                                 <
-sush: ./andbackup.sh: can't execute: Permission denied
-126|root@htc_himaul:/sdcard2/bk/andbackup # bash and    .
-bash and
-andbackup.sh andbackup/
-ash andbackup.sh                                                              <
-shell-init: error retrieving current directory: getcwd: cannot access parent directories: Success
-andbackup.sh: line 269: @: unbound variable
-1|root@htc_himaul:/sdcard2/bk/andbackup #
----
-
-
-WINDOWS SHELL doesn't have this problem, so autocomplete and last command are clean.  But the "unbound variable" happens also, this is fixed by passing the correct parameter count. (bash bug?)  
-
-
-BASH
-To my surprise BASH doesn't come with busybox.  To install bash do this:
-Go to this site and follow its directions (http://www.blogzamana.com/getting-bash-on-android/)
-Or just copy what I did here:
-$ wget http://pub.mzet.net/bash
-$ adb push bash /sdcard2/Download
--
-root@htc_himaul:/ # mount -o remount,rw /system
-mount -o remount,rw /system
-root@htc_himaul:/ # cd /system/bin
-root@htc_himaul:/system/bin # cp /sdcard2/Download/bash .
-root@htc_himaul:/system/bin # chmod 0755 bash
-root@htc_himaul:/storage/034A-1326/bk/andbackup # mount -o ro,remount,ro /system
--
-Thanks (http://android.stackexchange.com/questions/110927/how-to-mount-system-rewritable-or-read-only-rw-ro) for mount tips.
-
-TODO BUGS
-1)
-FIXED 
-  by Aaron in commit  9a95d9999343026480b6bf934ac31954a64f93de
-  next steps are to VERIFY/ACCEPT
----
-22:30:17 2017-03-18   info    Backing up com.nianticlabs.pokemongo
-cp: /storage/ext_sd/bk/andbackup/andbackupBK/com.nianticlabs.pokemongo/data//lib: Function not implemented
-deleting cache for com.nianticlabs.pokemongo
-22:30:49 2017-03-18   info    Compressing userdata for com.nianticlabs.pokemongo
-chdir: error retrieving current directory: getcwd: cannot access parent directories: Success
-This app com.google.android.apps.maps-preserveDignity has passed in options
-22:30:51 2017-03-18   info    Backing up com.google.android.apps.maps
-deleting cache for com.google.android.apps.maps
-22:33:19 2017-03-18   info    Compressing userdata for com.google.android.apps.maps
-root@htc_himaul:/sdcard2/bk/andbackup #
----
-The "Function not implemented" error output above might be because andbackup can't handle symlinks
-
-2)
-Most shells and even BASH has this bug:
----
-shell-init: error retrieving current directory: getcwd: cannot access parent directories: Success
----
-but it appears to run...
-
-3)
-"sh" doesn't work:
----
-1|root@htc_himaul:/sdcard2/bk/andbackup # sh andbackup.sh
-127|root@htc_himaul:/sdcard2/bk/andbackup #
----
-sh AKA ash doesn't work (with -x):
----
-1|root@htc_himaul:/storage/ext_sd/bk/andbackup # sh -x andbackup.sh
-127|root@htc_himaul:/storage/ext_sd/bk/andbackup #
--even with full correct params you get the same "nothing" output
-127|root@htc_himaul:/storage/ext_sd/bk/andbackup # sh -x andbackup.sh listback>
-127|root@htc_himaul:/storage/ext_sd/bk/andbackup #
----
diff --git a/README.rst b/README.rst
new file mode 100644
index 0000000..547aba4
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,43 @@
+======
+README
+======
+
+Andbackup is a basic Android application (or package) backup and restore
+script. It can backup a single application, or a list of applications provided
+in a text file (one application name per line). It can do the same for
+application restore.
+
+**NOTE**: The andbackup.sh script requires root to run.
+
+
+Usage
+=====
+
+::
+
+  sh andbackup.sh <action> [<application_name>] [<list_file>]
+
+
+Example Usage
+=============
+
+Perform bulk backup from application list in file *apps.txt*::
+
+  sh andbackup.sh listbackup apps.txt
+
+
+Backup a single app (K9 mail for this example)::
+
+  sh andbackup.sh backup com.fsck.k9
+
+
+Restore a single app (again, K9 mail in this example)::
+
+  sh andbackup.sh restore com.fsck.k9
+
+
+Perform bulk restore from application list in file *apps.txt*::
+
+  sh andbackup.sh listrestore apps.txt
+
+
diff --git a/TODO.rst b/TODO.rst
new file mode 100644
index 0000000..1cc9bda
--- /dev/null
+++ b/TODO.rst
@@ -0,0 +1,57 @@
+====
+TODO
+====
+
+Features
+========
+
+
+
+Bugs
+====
+
+
+1. *FIXED* by Aaron in commit 9a95d9999343026480b6bf934ac31954a64f93de
+   next steps are to VERIFY/ACCEPT
+   ::
+
+     22:30:17 2017-03-18   info    Backing up com.nianticlabs.pokemongo
+     cp: /storage/ext_sd/bk/andbackup/andbackupBK/com.nianticlabs.pokemongo/data//lib: Function not implemented
+     deleting cache for com.nianticlabs.pokemongo
+     22:30:49 2017-03-18   info    Compressing userdata for com.nianticlabs.pokemongo
+     chdir: error retrieving current directory: getcwd: cannot access parent directories: Success
+     This app com.google.android.apps.maps-preserveDignity has passed in options
+     22:30:51 2017-03-18   info    Backing up com.google.android.apps.maps
+     deleting cache for com.google.android.apps.maps
+     22:33:19 2017-03-18   info    Compressing userdata for com.google.android.apps.maps
+     root@htc_himaul:/sdcard2/bk/andbackup #
+
+The "Function not implemented" error output above might be because andbackup can't handle symlinks
+
+
+2. Most shells and even BASH has this bug
+   ::
+
+     shell-init: error retrieving current directory: getcwd: cannot access parent directories: Success
+
+but it appears to run...
+
+
+3. "sh" doesn't work
+   ::
+
+     1|root@htc_himaul:/sdcard2/bk/andbackup # sh andbackup.sh
+     127|root@htc_himaul:/sdcard2/bk/andbackup #
+
+   sh AKA ash doesn't work (with -x)
+   ::
+
+     1|root@htc_himaul:/storage/ext_sd/bk/andbackup # sh -x andbackup.sh
+     127|root@htc_himaul:/storage/ext_sd/bk/andbackup #
+
+   -even with full correct params you get the same "nothing" output
+   ::
+
+     127|root@htc_himaul:/storage/ext_sd/bk/andbackup # sh -x andbackup.sh listback>
+     127|root@htc_himaul:/storage/ext_sd/bk/andbackup #
+