gitback/known-folders
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

split up readme

Browse Source
This commit is contained in:
nycex 2020-05-28 20:57:54 +02:00
parent b1b49e9456
commit fe8c3e1d02
No known key found for this signature in database
GPG Key ID: EE6FBE8D3E7278A5
2 changed files with 38 additions and 42 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

42
README.md
View File

@ -6,48 +6,6 @@
- Provide the user with an option to either obtain a directory handle or a path name
- Keep to folders that are available on all operating systems
## Resources
### *nix / XDG
- https://www.freedesktop.org/wiki/Software/xdg-user-dirs/
- https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html
### Windows
- https://docs.microsoft.com/en-us/previous-versions/windows/desktop/legacy/bb776911(v=vs.85)
- Vista or newer: SHGetKnownFolderPath
- Earlier: SHGetFolderPath
### MacOS
- https://developer.apple.com/library/archive/documentation/FileManagement/Conceptual/FileSystemProgrammingGuide/FileSystemOverview/FileSystemOverview.html#//apple_ref/doc/uid/TP40010672-CH2-SW6
## Similar Packages
(for reference)
- https://docs.rs/directories/2.0.2/directories/index.html
## Open Questions
- how do we handle xdg dirs when wanted on mac?
## Folder List
| Folder | Windows | xdg | MacOS |
|-----------------------|--------------------------|----------------------------|-----------|
| Home | FOLDERID_Profile | HOME | HOME |
| Documents | FOLDERID_Documents | XDG_DOCUMENTS_DIR | HOME/Documents |
| Pictures | FOLDERID_Pictures | XDG_PICTURES_DIR | HOME/Pictures |
| Music | FOLDERID_Music | XDG_MUSIC_DIR | HOME/Music |
| Videos | FOLDERID_Videos | XDG_VIDEOS_DIR | HOME/Movies |
| Desktop | FOLDERID_Desktop | XDG_DESKTOP_DIR | HOME/Desktop |
| Downloads | FOLDERID_Downloads | XDG_DOWNLOAD_DIR | HOME/Downloads |
| Public | FOLDERID_Public | XDG_PUBLICSHARE_DIR | HOME/Public |
| Fonts | FOLDERID_Fonts | XDG_DATA_HOME/fonts | HOME/Library/Fonts |
| App Menu | FOLDERID_StartMenu | XDG_DATA_HOME/applications | HOME/Applications |
| Cache | %LOCALAPPDATA%/Temp | XDG_CACHE_HOME | HOME/Library/Caches |
| Roaming Configuration | %APPDATA% | XDG_CONFIG_HOME | HOME/Library/Preferences |
| Local Configuration | %LOCALAPPDATA% | XDG_CONFIG_HOME | HOME/Library/Application Support |
| Data | %APPDATA% | XDG_DATA_HOME | HOME/Library/Application Support |
| Runtime | %LOCALAPPDATA%/Temp | XDG_RUNTIME_DIR | HOME/Library/Application Support |
## API
```zig
pub const KnownFolder = enum {

38
RESOURCES.md Normal file
View File

@ -0,0 +1,38 @@
## Resources
### *nix / XDG
- https://www.freedesktop.org/wiki/Software/xdg-user-dirs/
- https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html
### Windows
- https://docs.microsoft.com/en-us/previous-versions/windows/desktop/legacy/bb776911(v=vs.85)
- Vista or newer: SHGetKnownFolderPath
- Earlier: SHGetFolderPath
### MacOS
- https://developer.apple.com/library/archive/documentation/FileManagement/Conceptual/FileSystemProgrammingGuide/FileSystemOverview/FileSystemOverview.html#//apple_ref/doc/uid/TP40010672-CH2-SW6
## Similar Packages
(for reference)
- https://docs.rs/directories/2.0.2/directories/index.html
## Folder List
| Folder | Windows | xdg | MacOS |
|-----------------------|--------------------------|----------------------------|-----------|
| Home | FOLDERID_Profile | HOME | HOME |
| Documents | FOLDERID_Documents | XDG_DOCUMENTS_DIR | HOME/Documents |
| Pictures | FOLDERID_Pictures | XDG_PICTURES_DIR | HOME/Pictures |
| Music | FOLDERID_Music | XDG_MUSIC_DIR | HOME/Music |
| Videos | FOLDERID_Videos | XDG_VIDEOS_DIR | HOME/Movies |
| Desktop | FOLDERID_Desktop | XDG_DESKTOP_DIR | HOME/Desktop |
| Downloads | FOLDERID_Downloads | XDG_DOWNLOAD_DIR | HOME/Downloads |
| Public | FOLDERID_Public | XDG_PUBLICSHARE_DIR | HOME/Public |
| Fonts | FOLDERID_Fonts | XDG_DATA_HOME/fonts | HOME/Library/Fonts |
| App Menu | FOLDERID_StartMenu | XDG_DATA_HOME/applications | HOME/Applications |
| Cache | %LOCALAPPDATA%/Temp | XDG_CACHE_HOME | HOME/Library/Caches |
| Roaming Configuration | %APPDATA% | XDG_CONFIG_HOME | HOME/Library/Preferences |
| Local Configuration | %LOCALAPPDATA% | XDG_CONFIG_HOME | HOME/Library/Application Support |
| Data | %APPDATA% | XDG_DATA_HOME | HOME/Library/Application Support |
| Runtime | %LOCALAPPDATA%/Temp | XDG_RUNTIME_DIR | HOME/Library/Application Support |