summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTrent Mick <trentm@gmail.com>2010-07-27 21:49:49 -0700
committerTrent Mick <trentm@gmail.com>2010-07-27 21:49:49 -0700
commitf49a3116ecb2ebd068b910f256d003831de22c92 (patch)
tree2e973c7742c3bb2b8d4ab2ddca951d4476e41d6a
parent778ced2461de059ab7f1df6c9c7f69627cea7913 (diff)
downloadappdirs-f49a3116ecb2ebd068b910f256d003831de22c92.tar.gz
TODOs
-rw-r--r--README.md10
-rw-r--r--TODO.md3
2 files changed, 11 insertions, 2 deletions
diff --git a/README.md b/README.md
index e489c30..c0f086e 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,4 @@
-# The Problem
+# the problem
What directory should your app use for storing user data? If running on Mac OS X, you
should use:
@@ -20,7 +20,7 @@ On Linux (and other Unices) the dir is typically:
~/.<appname> # note AppName was lowercased
-# `appdirs`
+# `appdirs` to the rescue
This kind of thing is what the `appdirs` module is for. `appdirs`:
@@ -31,6 +31,12 @@ This kind of thing is what the `appdirs` module is for. `appdirs`:
- is slightly opinionated on the directory names used (especially on Linux/Unix
where standards for these dirs don't really exist, AFAIK)
+# some example output
+
+
+
+
+# typical usage
diff --git a/TODO.md b/TODO.md
new file mode 100644
index 0000000..d142a15
--- /dev/null
+++ b/TODO.md
@@ -0,0 +1,3 @@
+- fill out docs
+- complete the name change
+- add the AppDirs class for "typical usage"