Remove documentation from readme and instead forward to the readthedocs one

[gaborbernat]

👍 https://platformdirs.readthedocs.io/en/latest/

[papr]

What type of forwarding did you have in mind? Is the link in the repo description sufficient? Or should there be a minimal readme linking to the link above?

[Julian]

@papr a minimal (1-2 paragraph) README sending someone to the docs is probably the right idea.

[PhrozenByte]

In the past two years README.rst became even more outdated: It mentions neither site_cache_dir(), nor user_state_dir(), or site_runtime_dir(). For Windows it shows the C:\Documents and Settings\<User>\Application Data structure from Windows XP as examples.

However, README.rst generally explains the usage better:

• It includes example outputs (which makes it easier to find the right method)
• It explains the different usage types ({site,user}_*_{dir,path}() methods vs. PlatformDirs class)
• It better explains advanced features, like version, multipath, or switching to roaming on Windows

So, platformdirs should either keep an updated README.rst and add a link to the API docs, or should move all parts (including the descriptive parts) of README.rst to the API docs.

[gaborbernat]

PR welcome for the later.

[sarnold]

Somehow "moving" doesn't sound like the best answer? I agree with the "readme explains more" in general, it just needs to be kept up-to-date, eg, usr_log_dir in the Linux section does not match the actual dir path. That said, my usual approach to docs in general is to put a symlink to the readme file in the docs source directory and just use it for the main docs page like this. Maybe that's an option?

[gaborbernat]

I disagree on this, I prefer the index just link to the documentation page and that's it.

[sarnold]

Oh, i just made the path fix and example docs PR. It does look pretty good to my eye anyway...