summaryrefslogtreecommitdiff
path: root/README.rst
diff options
context:
space:
mode:
authoreddyp <eddy.petrisor+github.com@gmail.com>2013-02-26 09:51:32 +0200
committerEddy Petrișor <eddy.petrisor@gmail.com>2013-02-26 09:54:33 +0200
commit64d8c035628449b5b031644c140f7c0d8dbc2576 (patch)
treeaf7fca0a21df4e39a07837a61aa5dc30fd632d77 /README.rst
parentfb3f024df39ac24b0e4534ec3084ed1406f3fec2 (diff)
downloadappdirs-64d8c035628449b5b031644c140f7c0d8dbc2576.tar.gz
Sync README.rst description with latest fixes
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst15
1 files changed, 8 insertions, 7 deletions
diff --git a/README.rst b/README.rst
index c60e969..86b4276 100644
--- a/README.rst
+++ b/README.rst
@@ -17,10 +17,9 @@ or possibly::
for `roaming profiles <http://bit.ly/9yl3b6>`_ but that is another story.
On Linux (and other Unices) the dir, according to the `XDG
-spec <http://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html>`_
-(and subject to some interpretation), is::
+spec <http://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html>`_, is::
- ~/.config/<appname> # note AppName was lowercased
+ ~/.local/share/<AppName>
``appdirs`` to the rescue
@@ -78,13 +77,15 @@ On Linux::
>>> appname = "SuperApp"
>>> appauthor = "Acme"
>>> user_data_dir(appname, appauthor)
- '/home/trentm/.config/superapp
+ '/home/trentm/.local/share/SuperApp
>>> site_data_dir(appname, appauthor)
- '/etc/xdg/superapp'
+ '/usr/local/share/SuperApp'
+ >>> site_data_dir(appname, appauthor, returnlist=True)
+ '/usr/local/share/SuperApp:/usr/share/SuperApp'
>>> user_cache_dir(appname, appauthor)
- '/home/trentm/.cache/superapp'
+ '/home/trentm/.cache/SuperApp'
>>> user_log_dir(appname, appauthor)
- '/home/trentm/.cache/superapp/log'
+ '/home/trentm/.cache/SuperApp/log'
``AppDirs`` for convenience