Added intro to README, formatting & clarification

main
capntack 1 year ago
parent 78f840a9de
commit 137bbc375d

@ -4,7 +4,11 @@
<br> <br>
<place-holder> I ascribe to the [PARA Method](https://fortelabs.com/blog/para/) for organizing my to-do and [personal knowledge management](https://en.wikipedia.org/wiki/Personal_knowledge_management) / [second brain](https://fortelabs.com/blog/basboverview/) systems. A deep dive on how all of that works is out of the scope of this repo (if I ever write a blog post on it, I will link that here). But the short of it regarding how it applies here is that you sort everything into 4, and only 4, root directories in order of actionability: "Projects", "Areas", "Resources", and "Archives". And you only go one subdirectory deep within thos. As you will see below, I've expanded on that when it comes to my entire working file structure on my computers. I've aded "Inbox", User Directories", "Programs", and "DevMin" (my personal term for dev/git/admin type work on my homelab). And I also am not afraid to have as many subdirectories as necessary.
I've designed this system to be as portable as possible from one system to another, and from Linux to Windows. You could just about copy and paste the second brain root directory from any one to any other. Update a few symlinks if you're using them. And then point the system's user directories to their new locations, as appropriate.
My primary reason for uploading this here is to give myself an easy place to refer to it. But I figured I might as well make it public for others. I doubt anyone will use it exactly as I have it written down here, but hopefully you can find inspiration from it. As I update, I will move the now out of date versions to the `prior-versions.md` file and replace them with the new ones here in the `README.md` to keep the files in this repo at a minimum.
<br> <br>
@ -28,116 +32,118 @@
<br> <br>
### Linux Structure for v1.0.0 ### Linux Structure for v1.0.0
- **$HOME**
- **source-of-truth** >> second brain root directory - **file-structure-root** >> the root directory for everything that follows
- **00-inbox** >> default Desktop directory > Name this directory how you like, and place it wherever you please. Tho I recommend your $HOME directory.
- **downloads** >> default Downloads directory - **00-inbox** >> default Desktop directory
- **scans** >> for printer/scanner to upload to - **downloads** >> default Downloads directory
- **screenshots** >> for screenshot util to upload to - **scans** >> for printer/scanner to upload to
- **tmp** >> for "RAM" work - **screenshots** >> for screenshot util to upload to
- **10-projects** >> "P" in PARA - **tmp** >> for "RAM" work
- ${PROJECT-DIRECTORIES} - **10-projects** >> "P" in PARA
- **20-areas** >> 1st "A" in PARA - ${PROJECT-DIRECTORIES}
- ${AREA-DIRECTORIES} - **20-areas** >> 1st "A" in PARA
- **30-resources** >> "R" in PARA - ${AREA-DIRECTORIES}
- **40-archives** >> 2nd "A" in PARA - **30-resources** >> "R" in PARA
- **40-archives** >> 2nd "A" in PARA
- **filing-cabinet** >> for documents you would put in a physical filing cabinet
> symlinked to "$HOME/50-user-dirs/documents/"
- **manuals** >> for storing home/office manuals
- **glacial** >> for long term storage
> symlinked to "$HOME/50-user-dirs/documents/" <br>
> CD to where the directories/files to be archived are, and archive thusly:
> ```bash
> tar cf ${ARCHIVE_NAME}.tar.xz \
> --use-compress-program='xz -9v' \
> /path/to/glacial/${DIR_OR_FILE_TO_ARCHIVE}
> ```
- **50-user-dirs** user/profile directories
- **audiobooks** >> self-explanatory
- **bookmarks** >> symlinks to directories & files deep in the OS file system
- **documents** >> default Documents directory
- **filing-cabinet** >> for documents you would put in a physical filing cabinet - **filing-cabinet** >> for documents you would put in a physical filing cabinet
> symlinked to "$HOME/50-user-dirs/documents/" > symlink of "$HOME/40-archives/filing-cabinet"
- **manuals** >> for storing home/office manuals
- **glacial** >> for long term storage - **glacial** >> for long term storage
> symlinked to "$HOME/50-user-dirs/documents/" <br> > symlink of "$HOME/40-archives/glacial"
> CD to where the directories/files to be archived are, and archive thusly: - **obsidian-vaults** >> place Obsidian.md vaults here
> ```bash - ${VAULT-DIRECTORIES}
> tar cf ${ARCHIVE_NAME}.tar.xz \ - **templates** >> default Templates directory
> --use-compress-program='xz -9v' \ - **ebooks** >> self-explanatory
> /path/to/glacial/${DIR_OR_FILE_TO_ARCHIVE} - **images** >> default Pictures directory
> ``` - **music** >> default Music directory
- **50-user-dirs** user/profile directories - **shares** >> a directory to place shared directories in
- **audiobooks** >> self-explanatory - **cloud-shares** >> a directory to place cloud share directories in
- **bookmarks** >> symlinks to directories & files deep in the OS file system - ${CLOUD-SHARE-DIRECTORIES}
- **documents** >> default Documents directory - **network-shares** >> to "co-locate" your network shares with other shares
- **filing-cabinet** >> for documents you would put in a physical filing cabinet > symlink of "/mnt"
> symlink of "$HOME/40-archives/filing-cabinet" - **p2p-shares** >> a directory to place peer to peer shared directories in
- **glacial** >> for long term storage - ${P2P-SHARE-DIRECTORIES}
> symlink of "$HOME/40-archives/glacial" - **public-directory** >> default Public directory
- **obsidian-vaults** >> place Obsidian.md vaults here - **videos** >> default Videos directory
- ${VAULT-DIRECTORIES} - **60-programs** >> portable apps and the like
- **templates** >> default Templates directory - **70-devmin** >> to do any dev/git/admin work out of
- **ebooks** >> self-explanatory - **repos** >> for git/svc/etc repos
- **images** >> default Pictures directory - ${VERSION-CONTROL-SYSTEM-DIRECTORIES}
- **music** >> default Music directory - ${PROJECT-DIRECTORIES}
- **shares** >> a directory to place shared directories in - **scripts** >> place scripts in here and either add to path or copy script files from here to a dir in path
- **cloud-shares** >> a directory to place cloud share directories in - **vsc-workspaces** >> place VSCod[e|ium] workspace files in here
- ${CLOUD-SHARE-DIRECTORIES} - ./scratchpad.md >> a junk file use as a scratchpad
- **network-shares** >> to "co-locate" your network shares with other shares
> symlink of "/mnt"
- **p2p-shares** >> a directory to place peer to peer shared directories in
- ${P2P-SHARE-DIRECTORIES}
- **public-directory** >> default Public directory
- **videos** >> default Videos directory
- **60-programs** >> portable apps and the like
- **70-devmin** >> to do any dev/git/etc work out of
- **repos** >> for git/svc/etc repos
- ${VERSION-CONTROL-SYSTEM-DIRECTORIES}
- ${PROJECT-DIRECTORIES}
- **scripts** >> place scripts in here and either add to path or copy script files from here to a dir in path
- **vsc-workspaces** >> place VSCod[e|ium] workspace files in here
- ./scratchpad.md >> a junk file use as a scratchpad
*Note:* To modify the default user directories on Linux, edit the `user-dirs.dirs` file, often located in `$HOME/.config/`. You cannot add directories to the config file, but you can edit the paths of the existing ones. They must be relative to `$HOME` and changes will take effect after relogging. *Note:* To modify the default user directories on Linux, edit the `user-dirs.dirs` file, often located in `$HOME/.config/`. You cannot add directories to the config file, but you can edit the paths of the existing ones. They must be relative to `$HOME` and changes will take effect after relogging.
<br> <br>
### Windows Structure for v1.0.0 ### Windows Structure for v1.0.0
- **$HOME**
- **source-of-truth** >> second brain root directory - **file-structure-root** >> the root directory for everything that follows
- **00-inbox** >> default Desktop directory > Name this directory how you like, and place it wherever you please. Tho I recommend your $HOME directory.
- **downloads** >> default Downloads directory - **00-inbox** >> default Desktop directory
- **scans** >> for printer/scanner to upload to - **downloads** >> default Downloads directory
- **screenshots** >> for screenshot util to upload to - **scans** >> for printer/scanner to upload to
- **tmp** >> for "RAM" work - **screenshots** >> for screenshot util to upload to
- **10-projects** >> "P" in PARA - **tmp** >> for "RAM" work
- ${PROJECT-DIRECTORIES} - **10-projects** >> "P" in PARA
- **20-areas** >> 1st "A" in PARA - ${PROJECT-DIRECTORIES}
- ${AREA-DIRECTORIES} - **20-areas** >> 1st "A" in PARA
- **30-resources** >> "R" in PARA - ${AREA-DIRECTORIES}
- **40-archives** >> 2nd "A" in PARA - **30-resources** >> "R" in PARA
- **40-archives** >> 2nd "A" in PARA
- **filing-cabinet** >> for documents you would put in a physical filing cabinet
> symlinked to "$HOME/50-user-dirs/documents/"
- **manuals** >> for storing home/office manuals
- **glacial** >> for long term storage
> symlinked to "$HOME/50-user-dirs/documents/" <br>
> Archive directories/files using [7zip](https://www.7-zip.org). First "Add to archive..." as a .tar, then again as an .xz with Ultra Compression Level. Then move the archive here.
- **50-user-dirs** user/profile directories
- **audiobooks** >> self-explanatory
- **bookmarks** >> symlinks to directories & files deep in the OS file system
- **documents** >> default Documents directory
- **filing-cabinet** >> for documents you would put in a physical filing cabinet - **filing-cabinet** >> for documents you would put in a physical filing cabinet
> symlinked to "$HOME/50-user-dirs/documents/" > symlink of "$HOME/40-archives/filing-cabinet"
- **manuals** >> for storing home/office manuals
- **glacial** >> for long term storage - **glacial** >> for long term storage
> symlinked to "$HOME/50-user-dirs/documents/" <br> > symlink of "$HOME/40-archives/glacial"
> Archive directories/files using [7zip](https://www.7-zip.org). First "Add to archive..." as a .tar, then again as an .xz with Ultra Compression Level. Then move the archive here. - **obsidian-vaults** >> place Obsidian.md vaults here
- **50-user-dirs** user/profile directories - ${VAULT-DIRECTORIES}
- **audiobooks** >> self-explanatory - **templates** >> simply here for parity between Linux & Windows setups
- **bookmarks** >> symlinks to directories & files deep in the OS file system - **ebooks** >> self-explanatory
- **documents** >> default Documents directory - **images** >> default Pictures directory
- **filing-cabinet** >> for documents you would put in a physical filing cabinet - **music** >> default Music directory
> symlink of "$HOME/40-archives/filing-cabinet" - **shares** >> a directory to place shared directories in
- **glacial** >> for long term storage - **cloud-shares** >> a directory to place cloud share directories in
> symlink of "$HOME/40-archives/glacial" - ${CLOUD-SHARE-DIRECTORIES}
- **obsidian-vaults** >> place Obsidian.md vaults here - **network-shares** >> to "co-locate" your network shares with other shares
- ${VAULT-DIRECTORIES} > need to verify method of showing those here
- **templates** >> simply here for parity between Linux & Windows setups - **p2p-shares** >> a directory to place peer to peer shared directories in
- **ebooks** >> self-explanatory - ${P2P-SHARE-DIRECTORIES}
- **images** >> default Pictures directory - **public-directory** >> simply here for parity between Linux & Windows setups
- **music** >> default Music directory - **videos** >> default Videos directory
- **shares** >> a directory to place shared directories in - **60-programs** >> portable apps and the like
- **cloud-shares** >> a directory to place cloud share directories in - **70-devmin** >> to do any dev/git/admin work out of
- ${CLOUD-SHARE-DIRECTORIES} - **repos** >> for git/svc/etc repos
- **network-shares** >> to "co-locate" your network shares with other shares - ${VERSION-CONTROL-SYSTEM-DIRECTORIES}
> need to verify method of showing those here - ${PROJECT-DIRECTORIES}
- **p2p-shares** >> a directory to place peer to peer shared directories in - **scripts** >> place scripts in here and either add to path or copy script files from here to a dir in path
- ${P2P-SHARE-DIRECTORIES} - **vsc-workspaces** >> place VSCod[e|ium] workspace files in here
- **public-directory** >> simply here for parity between Linux & Windows setups - ./scratchpad.md >> a junk file use as a scratchpad
- **videos** >> default Videos directory
- **60-programs** >> portable apps and the like
- **70-devmin** >> to do any dev/git/etc work out of
- **repos** >> for git/svc/etc repos
- ${VERSION-CONTROL-SYSTEM-DIRECTORIES}
- ${PROJECT-DIRECTORIES}
- **scripts** >> place scripts in here and either add to path or copy script files from here to a dir in path
- **vsc-workspaces** >> place VSCod[e|ium] workspace files in here
- ./scratchpad.md >> a junk file use as a scratchpad
*Note:* To modify the default user directories on Windows, rename them first, then move them in a top down order (i.e. move Downloads into Desktop after having already moved Desktop) to avoid any weirdness. Rename using [these directions](https://superuser.com/a/1578148). *Note:* To modify the default user directories on Windows, rename them first, then move them in a top down order (i.e. move Downloads into Desktop after having already moved Desktop) to avoid any weirdness. Rename using [these directions](https://superuser.com/a/1578148).

@ -20,7 +20,8 @@
### Windows Structure for v0.1.0 ### Windows Structure for v0.1.0
- **Documents** >> default Documents directory - **Documents** >> default Documents directory
- **!Source of Truth** >> second brain root directory - **file-structure-root** >> the root directory for everything that follows
> Name this directory how you like
- **00-Inbox** >> default Desktop directory - **00-Inbox** >> default Desktop directory
- **!Downloads** >> default Downloads directory - **!Downloads** >> default Downloads directory
- **!Scans** >> for printer/scanner to upload to - **!Scans** >> for printer/scanner to upload to

Loading…
Cancel
Save