diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f37efd9..8916ee9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -12,7 +12,7 @@ If you want to help out and contribute to this filetree, please follow this basi * create/extends the folder structure → e.g. `/root/foo/bar` -* make sure the deeply nested folder contains at least one placeholder file → +* make sure the deeply nested folder contains at least one placeholder file → `/root/foo/bar/example.doc` @@ -26,17 +26,14 @@ If you want to help out and contribute to this filetree, please follow this basi please create a new branch on your fork with this pattern: `user/nickname` - - ------ ## Issues We also welcome any discussion in the *issues* section. Feel free to open a new issue if you see something missing or an error. You can also help discuss uncertain topics and contribute by posting your opinion on certain structures/namings/etc. - ------ -## Further Notes: +## Further Notes * If you are going to refactor a certain section or want to add a completely new section, we'd appreciate it that you create a feature branch for it, since that makes it a lot easier tracking the project and handling pull-requests. diff --git a/README.md b/README.md index 14434b5..9ab3800 100644 --- a/README.md +++ b/README.md @@ -4,8 +4,6 @@ Hello and welcome to the [r/datacurator](https://reddit.com/r/datacurator) filet We aim to create a unified filetree for all kinds of data, which should help in storing, categorising and retrieving. - - ## Branches You are now looking at the default full-blown filetree. Often times you don't need that. So we have a few other variants that you can use, which may better fit your use-case. @@ -22,16 +20,11 @@ You are now looking at the default full-blown filetree. Often times you don't ne > > We will try to review and incorporate it here. - - - ## Overview Here is a quick screenshot on what the current tree looks like (occasionally updated). -![](overview.png) - - +![file-tree](overview.png) ## Contributing diff --git a/root/README.md b/root/README.md index e9e83b0..cfde515 100644 --- a/root/README.md +++ b/root/README.md @@ -6,8 +6,6 @@ Usually people use an external drive, a network share exposed by a NAS or even b The **root** defines several *main sections*. These main sections allow for an easy seperation of content and should stay within a certain cognitive complexity. - - ## Overview | Folder | Contents | @@ -22,8 +20,6 @@ The **root** defines several *main sections*. These main sections allow for an e | software | Computer Applications, Mobile Apps, Operating Systems | | video | Movies, Short Movies/Films, TV-Shows, ... | - - ## General Advice In this Section we want to give you some general advice on things you should be aware of. @@ -34,7 +30,7 @@ These are optional and sometimes biased. If you do not agree to them - be it par 1. Naming in General -Naming is hard. We know that. You want everything neat and tidy, but sometimes things just don't go that way - and that is perfectly fine. **Don't be afraid to break the rules and adjust this tree to your needs.** + Naming is hard. We know that. You want everything neat and tidy, but sometimes things just don't go that way - and that is perfectly fine. **Don't be afraid to break the rules and adjust this tree to your needs.** 2. Technical Issues @@ -45,7 +41,7 @@ Here is a small (and incomplete) list of characters you should avoid (AKA "Forbi - *Please use this list as a general rule of thumb.* - *The List applies to all major operating systems.* -``` +```txt File Seperators: : (colon) / (forward slash) diff --git a/root/archives/README.md b/root/archives/README.md index 586c570..6c508eb 100644 --- a/root/archives/README.md +++ b/root/archives/README.md @@ -1,3 +1,5 @@ +# ./archives + ## Content The archives section has the least strict rules about file allocation for any top-level directory, however, it is still important that it is understood what can go in the section and what cannot. Generally, any particular file that you struggle to allocate to any top-level directory can typically be put into the archives directory, as those files will typically be for 'archival' purposes. The only potential exception is creative assets, as these can often be actively used, so these could also be split into a new top-level directory if you choose. @@ -13,10 +15,6 @@ The archives section has the least strict rules about file allocation for any to | websites | snapshots of websites at a specific time | | | | - - ## Patterns - - -## Resources \ No newline at end of file +## Resources diff --git a/root/archives/datasets/README.md b/root/archives/datasets/README.md index b039048..0b3a3c2 100644 --- a/root/archives/datasets/README.md +++ b/root/archives/datasets/README.md @@ -1,10 +1,7 @@ -# Content +# ./archives/datasets -collections of data, typically in tabular format +## Content +Collections of data, typically in tabular format - - - -- https://en.wikipedia.org/wiki/Data_set - +- [Data set](https://en.wikipedia.org/wiki/Data_set) diff --git a/root/archives/datasets/research/README.md b/root/archives/datasets/research/README.md index cebd99c..38a4adf 100644 --- a/root/archives/datasets/research/README.md +++ b/root/archives/datasets/research/README.md @@ -1,6 +1,7 @@ +# ./archives/datasets/research + Example Datasets for Machine Learning Research: - CIFAR-10, CIFAR-100 - MNIST - FIND - diff --git a/root/archives/datasets/statistics/README.md b/root/archives/datasets/statistics/README.md index 1937599..dc67333 100644 --- a/root/archives/datasets/statistics/README.md +++ b/root/archives/datasets/statistics/README.md @@ -1,4 +1,5 @@ +# ./archives/datasets/statistics + Tabular Data for Statistics - mostly CSV, XLSX, XML, JSON - diff --git a/root/archives/news/README.md b/root/archives/news/README.md index 5f1d9d7..08a6a03 100644 --- a/root/archives/news/README.md +++ b/root/archives/news/README.md @@ -1,4 +1,3 @@ # News > Information/intel about events/history, including leaked confidential data. - diff --git a/root/archives/sientific/README.md b/root/archives/sientific/README.md index 77426f3..af884df 100644 --- a/root/archives/sientific/README.md +++ b/root/archives/sientific/README.md @@ -1,11 +1,16 @@ +# ./archives/scientific + For scientific papers Naming scheme could be: + +```html - <(short) title> () +``` DOI would be optional. For author you can use: One: [author 1] Two: [author 1] & [author 2] -Three or more: [author1] et al. +Three or more: [author1] et al. diff --git a/root/archives/websites/README.MD b/root/archives/websites/README.MD index 8553bc9..ea264a9 100644 --- a/root/archives/websites/README.MD +++ b/root/archives/websites/README.MD @@ -1,3 +1,5 @@ +# ./archives/websites + ## Content Basically snapshots/dumps/rips of a given website/webapp bound to a point in time. @@ -10,4 +12,4 @@ Basically snapshots/dumps/rips of a given website/webapp bound to a point in tim ## Resources -- https://archive.org/ +- [Archive.org](https://archive.org/) diff --git a/root/audio/README.MD b/root/audio/README.MD index 8e3c164..81e7968 100644 --- a/root/audio/README.MD +++ b/root/audio/README.MD @@ -1,3 +1,5 @@ +# ./audio + ## Content The (digital) audio section contains any kind of sound that is contained within a file - such as music, sounds, sound effects, podcasts, audiobooks, event recordings (musicals, concerts, standup comedy), games and many others. @@ -22,7 +24,7 @@ File naming among music files is a very common topic among enthusiasts and it di Please feel free to create your own pattern, by reading through the many many forum posts that people started. If you want a quickstart, here are a few common patterns: -``` +```md # + -------------------------------------------------------------------------------- # | Music @@ -46,7 +48,7 @@ ALBUM_ARTIST/ALBUM_ARTIST - ALBUM (YEAR) [FORMAT]/CD N/TRACKNR - ARTIST - TRACKT ## Resources -- https://musicbrainz.org/ - A community-maintained music metadata database. -- https://www.discogs.com/ - A database and marketplace for music. -- https://hydrogenaud.io/ - A community for discussion of audio technology. -- http://beets.io/ - A command-line based music tagger and cataloger. +- [A community-maintained music metadata database.](https://musicbrainz.org/) +- [A database and marketplace for music.](https://www.discogs.com/) +- [A community for discussion of audio technology.](https://hydrogenaud.io/) +- [A command-line based music tagger and cataloger.](http://beets.io/) diff --git a/root/audio/music/README.md b/root/audio/music/README.md index a43c892..fafe52a 100644 --- a/root/audio/music/README.md +++ b/root/audio/music/README.md @@ -1,28 +1,30 @@ +# ./audio/music + Artist - \ Artist - Year - Album [SOURCE - FORMAT - RES] {Catalog/Info} - \ Disc#-Track# - TrackTitle + \ Artist - Year - Album [SOURCE - FORMAT - RES] {Catalog/Info} + \ Disc#-Track# - TrackTitle Notes: - Artist is case sensitive - Unicode is possible, if you have problems - refer to plain ASCII - The `{Catalog/Info}` is optional - - should be used if Logs are present or you are 100% sure of the content - - Almost always applies to CD only + - Should be used if Logs are present or you are 100% sure of the content + - Almost always applies to CD only - `Disc#-` is optional if one likes to avoid CD1,CD2 subfolders - - In case of FLAC+Logfile splitted folders are considered best practice. + - In case of FLAC+Logfile splitted folders are considered best practice. Examples: -``` +```md A Great Big World - 2014 - Is There Anybody Out There [CD - FLAC - Lossless] Adele - 2015 - 25 [CD - FLAC - Lossless] {XLCD740} Adele - 2015 - Hello [WEB - FLAC - Lossless] Alligatoah - 2015 - Musik ist keine Lösung (Limited Deluxe Edition) [CD - FLAC - Lossless] - \ CD1,CD2,CD3 |or| Disc 1, Disc 2, Disc 3 + \ CD1,CD2,CD3 |or| Disc 1, Disc 2, Disc 3 Billy Talent - 2009 - III [CD - ALAC - Lossless] {Unknown Release} -``` \ No newline at end of file +``` diff --git a/root/audio/soundtracks/README.md b/root/audio/soundtracks/README.md index b98e9de..cd8d9a7 100644 --- a/root/audio/soundtracks/README.md +++ b/root/audio/soundtracks/README.md @@ -2,16 +2,12 @@ > Music and sound specifically created/composed/compiled for a movie, television show or videogame etc. - - **NOTE:** This folder is pretty much **optional**. Every Soundtrack usually comes with an album-artist, composer, artist, etc. This folder only exists for people who like to separate the common `artist - album` releases from soundtracks specifically. Reasons vary, but you can usually find things faster when it's splitted. - - ## Variants Soundtracks: @@ -28,7 +24,7 @@ Soundtracks: > An officially released album that contains music from the original in-game audio. > -> Examples: +> Examples: > > - Chrono Trigger Original Sound Version @@ -41,18 +37,15 @@ Soundtracks: > - Title (Score) > - Title (Soundtrack) -``` +```md Music From The Original Motion Picture Soundtrack Music From And Inspired By The Motion Picture ``` - - ## Resources -- https://en.wikipedia.org/wiki/Soundtrack - -- https://en.wikipedia.org/wiki/Soundtrack_album +- [Soundtrack](https://en.wikipedia.org/wiki/Soundtrack) -- https://en.wikipedia.org/wiki/Video_game_music +- [Soundtrack album](https://en.wikipedia.org/wiki/Soundtrack_album) +- [Video game music](https://en.wikipedia.org/wiki/Video_game_music) diff --git a/root/documents/README.md b/root/documents/README.md index 34e6675..f73d04d 100644 --- a/root/documents/README.md +++ b/root/documents/README.md @@ -1,3 +1,5 @@ +# ./documents + ## Content Personal documents like letters, poems, forms, bills, etc. @@ -14,11 +16,11 @@ One of the most common file naming schemes is the use of the date in ISO8601 for > 2019-09-01 - August 2019 Utilities Bill.pdf -``` +```md # TODO: Personal File Naming Patterns # e.g. bills (yyyy-mm-dd - 20 char description.pdf) ``` ## Resources -- http://www.asianefficiency.com/organization/organizing-files-folders-documents/ +- [How to Organize Files, Folders and Documents For Maximum Productivity](http://www.asianefficiency.com/organization/organizing-files-folders-documents/) diff --git a/root/games/README.MD b/root/games/README.MD index f31d232..d1beae6 100644 --- a/root/games/README.MD +++ b/root/games/README.MD @@ -2,17 +2,12 @@ > A game is a structured form of play, usually undertaken for entertainment or fun, and sometimes used as an educational tool. - - For archiving games, we must shift our focus away from the pure videogame section towards the broader landscape that is interactive entertainment. There is a lot to cover, but we try to keep it simple. If you only use this games folder for videogames, you can remove the other folders and reduce the depth a bit. Each Section here has enough sub-sections to deal with. You can (and should) always keep it as flat as possible until you outgrow that system and need to nest more. Folder names are intentionally lowercase to not mess with different systems and to have a cli friendy structure. You can change that if you wish to, especially further down e.g. on the individual videogame systems or on certain tabletop games. It really depends if you curate for accessiblity or for pure archival. - - ## Resources -- https://en.wikipedia.org/wiki/Game - +- [Game](https://en.wikipedia.org/wiki/Game) diff --git a/root/games/sport/README.md b/root/games/sport/README.md index dd6ee5e..f1b377e 100644 --- a/root/games/sport/README.md +++ b/root/games/sport/README.md @@ -1,4 +1,3 @@ # Sport Games -> - +> diff --git a/root/games/video/arcade/README.md b/root/games/video/arcade/README.md index 73b27ca..9e24bd4 100644 --- a/root/games/video/arcade/README.md +++ b/root/games/video/arcade/README.md @@ -1,2 +1 @@ # Arcade - diff --git a/root/games/video/computer/README.md b/root/games/video/computer/README.md index c5d7155..4799468 100644 --- a/root/games/video/computer/README.md +++ b/root/games/video/computer/README.md @@ -2,8 +2,6 @@ > Mainly Linux, Mac and Windows - - Potential Naming Options | <~ | ~~ | ~> | @@ -12,9 +10,7 @@ Potential Naming Options | win | windows | Windows | | nix | linux | Linux | - - ## Resources -- https://en.wikipedia.org/wiki/PC_game -- https://en.wikipedia.org/wiki/Mac_gaming \ No newline at end of file +- [PC game](https://en.wikipedia.org/wiki/PC_game) +- [Mac gaming](https://en.wikipedia.org/wiki/Mac_gaming) diff --git a/root/games/video/console/README.md b/root/games/video/console/README.md index 528b3b4..c61297e 100644 --- a/root/games/video/console/README.md +++ b/root/games/video/console/README.md @@ -2,8 +2,6 @@ > = Home Video Game Consoles - - Potential Folder Names for each Platform/System (short→long) ```ini @@ -16,8 +14,6 @@ Sony PlayStation > Use the style that fits your case best. If you have lots of automation, you appreciate the shorter and lowercase+dashed variants. If you want a "nice to browse" collection, choose the longer and explicit style. - - Each System Folder may include - Games @@ -27,9 +23,6 @@ Each System Folder may include - Instructions, Manuals, Booklets - Design Documents - - ## Resources -- https://en.wikipedia.org/wiki/List_of_home_video_game_consoles - +- [List of home video game consoles](https://en.wikipedia.org/wiki/List_of_home_video_game_consoles) diff --git a/root/games/video/handheld/README.md b/root/games/video/handheld/README.md index beb0251..5a6c71b 100644 --- a/root/games/video/handheld/README.md +++ b/root/games/video/handheld/README.md @@ -2,8 +2,6 @@ > = Handheld Consoles - - Potential Folder Names for each Platform/System (short→long) ```ini @@ -17,8 +15,6 @@ Nintendo Game Boy > Use the style that fits your case best. If you have lots of automation, you appreciate the shorter and lowercase+dashed variants. If you want a "nice to browse" collection, choose the longer and explicit style. - - Each System Folder may include - Games @@ -28,8 +24,6 @@ Each System Folder may include - Instructions, Manuals, Booklets - Design Documents - - ## Resources -- https://en.wikipedia.org/wiki/Handheld_game_console \ No newline at end of file +- [Handheld game console](https://en.wikipedia.org/wiki/Handheld_game_console) diff --git a/root/games/video/mobile/README.md b/root/games/video/mobile/README.md index c1b0e3e..e6090c3 100644 --- a/root/games/video/mobile/README.md +++ b/root/games/video/mobile/README.md @@ -1,6 +1,3 @@ # Mobile > iOS, Android, PDA, ... - - - diff --git a/root/images/README.md b/root/images/README.md index 00b88c1..fa0aa66 100644 --- a/root/images/README.md +++ b/root/images/README.md @@ -1,3 +1,5 @@ +# ./images + ## Content Images may include, but is not limited to: @@ -9,7 +11,7 @@ Images may include, but is not limited to: | Charts | Graphical representations of data, e.g graphs, chloropleth maps | | Memes | Internet memes, primarily created for humor | | Photos | Images that are taken of real life | -| Purpose-based | Subcategories of types of images that are used for a specific purpose +| Purpose-based | Subcategories of types of images that are used for a specific purpose | | Screenshots | Digital images of what appears on a screen | ## Patterns @@ -18,5 +20,5 @@ TODO ## Resources -* https://en.wikipedia.org/wiki/Image -* https://en.wikipedia.org/wiki/Work_of_art +- [Image](https://en.wikipedia.org/wiki/Image) +- [Work of art](https://en.wikipedia.org/wiki/Work_of_art) diff --git a/root/images/photos/README.md b/root/images/photos/README.md index ed458c1..16c8819 100644 --- a/root/images/photos/README.md +++ b/root/images/photos/README.md @@ -2,16 +2,12 @@ > Images taken from a digital camera or digitized versions of analog photographs. - - ## Structure This Section can get pretty personal, so this depends on use-cases again. If you are simply archiving a ton of photographs from a multitude of sources, try going for a year/month/day pattern and give each photo a date+hash combo to find duplicates more quickly. You can find tools for that as well. If you are curating a personal collection of photos you can invest a lot of time and create events arranged by year/month, but I usually recommend the broadly accepted: `year/yyyy-mm-dd` or `year/mm/dd` pattern. - - Example 1: ```i @@ -23,7 +19,7 @@ Example 1: Example 2: -``` +```md 2019/ 2019-05-25/ 7K4A8146.jpg @@ -31,4 +27,3 @@ Example 2: IMG_0181.JPG IMG_0182.MOV ``` - diff --git a/root/literature/README.MD b/root/literature/README.MD index 73923d7..098e71b 100644 --- a/root/literature/README.MD +++ b/root/literature/README.MD @@ -1,3 +1,5 @@ +# ./literature + ## Content **Common Literature:** @@ -13,33 +15,33 @@ → This Section offers multiple classification systems, ready to unpack and roll. -* [BISAC](https://bisg.org/page/bisacedition) (thanks to [u/hyperclick76](https://www.reddit.com/user/hyperclick76) !) -* [UDC](https://en.wikipedia.org/wiki/Universal_Decimal_Classification#Main_tables) (main tables only .. by u/roboyoshi) -* [LCC](https://en.wikipedia.org/wiki/Library_of_Congress_Classification#Classification) (main sections only .. by u/roboyoshi) -* [DDC](https://en.wikipedia.org/wiki/Dewey_Decimal_Classification#Classes) (main classes only .. by u/roboyoshi) +- [BISAC](https://bisg.org/page/bisacedition) (thanks to [u/hyperclick76](https://www.reddit.com/user/hyperclick76) !) +- [UDC](https://en.wikipedia.org/wiki/Universal_Decimal_Classification#Main_tables) (main tables only .. by u/roboyoshi) +- [LCC](https://en.wikipedia.org/wiki/Library_of_Congress_Classification#Classification) (main sections only .. by u/roboyoshi) +- [DDC](https://en.wikipedia.org/wiki/Dewey_Decimal_Classification#Classes) (main classes only .. by u/roboyoshi) I'd advise to unpack all and go through them real quick, then choose one of the classification systems that you find fits best to your needs and stick with it if possible. Throw away the rest. ## Patterns -* Check https://bookbrainz.org for Proper Author/Title Naming -* Include ISBN (10 or 13) similar to Music Releases -* Example: J.K. Rowling - Harry Potter and the Philosopher's Stone [English] {1408845644} -* ISBN-10 can be expanded to ISBN-13 by adding 978: {978-1408845646} +- Check [BookBrainz](https://bookbrainz.org) for Proper Author/Title Naming +- Include ISBN (10 or 13) similar to Music Releases +- Example: J.K. Rowling - Harry Potter and the Philosopher's Stone [English] {1408845644} +- ISBN-10 can be expanded to ISBN-13 by adding 978: {978-1408845646} **Naming Ideas:** - └── Lastname, Firstname - └── Firstname Lastname - [Book Series #] - Book Title {ISBN}.ext + └── Lastname, Firstname + └── Firstname Lastname - [Book Series #] - Book Title {ISBN}.ext ## Resources There are several classification systems for libraries to sort and catalog books. (See Wikipedia Link on Library Classifications) In this repository, we want to use such systems and provide examples on how they would be applied. -* [Wikipedia's "Books by Type" Overview](https://en.wikipedia.org/wiki/Category:Books_by_type) -* [An overview of Library Classification Systems](https://en.wikipedia.org/wiki/Library_classification#Methods_or_systems) -* [UDC aka Universal Decimal Classification](https://en.wikipedia.org/wiki/Universal_Decimal_Classification) -* [UDC Summary, a nice page to see the structure](http://www.udcsummary.info/php/index.php) -* [LCC aka Library of Congress Classification](https://en.wikipedia.org/wiki/Library_of_Congress_Classification) -* https://laureltarulli.wordpress.com/ +- [Wikipedia's "Books by Type" Overview](https://en.wikipedia.org/wiki/Category:Books_by_type) +- [An overview of Library Classification Systems](https://en.wikipedia.org/wiki/Library_classification#Methods_or_systems) +- [UDC aka Universal Decimal Classification](https://en.wikipedia.org/wiki/Universal_Decimal_Classification) +- [UDC Summary, a nice page to see the structure](http://www.udcsummary.info/php/index.php) +- [LCC aka Library of Congress Classification](https://en.wikipedia.org/wiki/Library_of_Congress_Classification) +- [The Cataloguing Librarian](https://laureltarulli.wordpress.com/) diff --git a/root/software/Applications/README.md b/root/software/Applications/README.md index d8d9a2c..36ac0ad 100644 --- a/root/software/Applications/README.md +++ b/root/software/Applications/README.md @@ -1,10 +1,12 @@ +# ./software/applications + There are a multitude operating systems, and there will only be more of them in the future. You should group these together by OS family. Users that have a great many OS families (collecting historical applications for abandoned operating systems and plaforms) might consider grouping by vendor first, then OS families. For example: /Android -Or: +Or: /Microsft /Win32 @@ -24,4 +26,4 @@ Those who have many hundreds of applications might consider grouping by vendor a /Adobe /Photoshop 14 -These are only guidelines, however. Feel free to adjust and modify, and don't forget that you can go back and change something if it still doesn't feel or work right. And if you think you've got something really clever, consider offering it back to the rest of us here at https://github.com/roboyoshi/datacurator-filetree . +These are only guidelines, however. Feel free to adjust and modify, and don't forget that you can go back and change something if it still doesn't feel or work right. And if you think you've got something really clever, consider offering it back to the rest of us here at [Datacurator filetree](https://github.com/roboyoshi/datacurator-filetree). diff --git a/root/software/Firmware/README.md b/root/software/Firmware/README.md index 5fb253d..38b1177 100644 --- a/root/software/Firmware/README.md +++ b/root/software/Firmware/README.md @@ -1,3 +1,5 @@ -Work in progress. Obviously there are many software-y files out there in the world that aren't scripts or operating systems or video games. You've downloaded more than a few of them for wireless routers and for various pieces of hardware. Keeping an archive of them (partial, just those you have used, or full, every version manufacturer has) only makes sense. They belong here. +# ./software/firmware -How to organize them? No clue. Perhaps manufacturer/model. Will return to this when it's clearer how to proceed. \ No newline at end of file +Work in progress. Obviously there are many software-y files out there in the world that aren't scripts or operating systems or video games. You've downloaded more than a few of them for wireless routers and for various pieces of hardware. Keeping an archive of them (partial, just those you have used, or full, every version manufacturer has) only makes sense. They belong here. + +How to organize them? No clue. Perhaps manufacturer/model. Will return to this when it's clearer how to proceed. diff --git a/root/software/README.MD b/root/software/README.MD index 0219d17..d65fa0f 100644 --- a/root/software/README.MD +++ b/root/software/README.MD @@ -1,8 +1,7 @@ -## Software +# ./software > Everything that is source code, compiled code or in other ways a form of digital applications. -* can be more than just PC (x86/x64) -* should also include "retro"-software -* can include games as well - +- Can be more than just PC (x86/x64) +- Should also include "retro"-software +- Can include games as well diff --git a/root/software/Scripts/README.md b/root/software/Scripts/README.md index 9c029f6..7275490 100644 --- a/root/software/Scripts/README.md +++ b/root/software/Scripts/README.md @@ -1,4 +1,6 @@ -This subdirectory exists for those scripts which are valuable in nature and that you would want to keep long term, but which you've written yourself or are otherwise unique. Organization is thus up to you. There is no requirement for subdirectories, especially if you have only a few dozen or less. +# ./software/scripts + +This subdirectory exists for those scripts which are valuable in nature and that you would want to keep long term, but which you've written yourself or are otherwise unique. Organization is thus up to you. There is no requirement for subdirectories, especially if you have only a few dozen or less. Note: Remember to strip these scripts of any sensitive usernames or passwords before archiving. If you have to retrieve them from your NAS because they've been lost elsewhere, it will only take a few minutes to add them back in, but it can take years to repair identity theft issues. Do not fool yourself that you've secured your data hoard sufficiently. Use a password manager. diff --git a/root/software/Source/README.md b/root/software/Source/README.md index e64f588..342fda5 100644 --- a/root/software/Source/README.md +++ b/root/software/Source/README.md @@ -2,8 +2,6 @@ > Copies of Version Controlled Code that is either a 1:1 copy of git/svn/.. or a tarball/zip. - - ## Structure If you have a lot of repos archived, then the golang approach is a reasonable solution: @@ -12,8 +10,6 @@ If you have a lot of repos archived, then the golang approach is a reasonable so // ``` - - Depending on the size of your aggregate, you can choose how far you want to nest or not: ```xml @@ -23,4 +19,3 @@ Depending on the size of your aggregate, you can choose how far you want to nest ^ // ``` - diff --git a/root/software/Typefaces/README.md b/root/software/Typefaces/README.md index 4e84d59..d37d512 100644 --- a/root/software/Typefaces/README.md +++ b/root/software/Typefaces/README.md @@ -6,18 +6,13 @@ - A **Font** is a particular size, weight and style of a typeface. - - **PLEASE NOTE:** This is for digital typefaces. There are *analog* typefaces as well, that are often categorized as images/glyphs. So if you want to preseve typefaces as a whole, maybe add them at the root level instead. - - ## Resources -- https://en.wikipedia.org/wiki/Font - -- https://old.reddit.com/r/datacurator/comments/axua17/fonts/ -- https://old.reddit.com/r/datacurator/comments/ayh4ss/fonts_part_two/ +- [Font - Wikipedia](https://en.wikipedia.org/wiki/Font) +- [Fonts - /r/datacurator](https://old.reddit.com/r/datacurator/comments/axua17/fonts/) +- [Fonts, part two - /r/datacurator](https://old.reddit.com/r/datacurator/comments/ayh4ss/fonts_part_two/) diff --git a/root/software/systems/README.md b/root/software/systems/README.md index f65f6cc..ce7637e 100644 --- a/root/software/systems/README.md +++ b/root/software/systems/README.md @@ -2,9 +2,7 @@ > System software is software designed to provide a platform for other software. (Operating Systems / Game Engines / SaaS Platforms) - - -There are many operating systems, and there will only be more of them in the future. You should group these together by vendor. Within these vendors, grouping them together by OS family is also a good idea. +There are many operating systems, and there will only be more of them in the future. You should group these together by vendor. Within these vendors, grouping them together by OS family is also a good idea. For each OS, I'd recommend it having its own subfolder. For example: @@ -12,7 +10,6 @@ For each OS, I'd recommend it having its own subfolder. For example: /Windows /Windows 3.11 - Thus, other supplementary files can be stored along with the installation files (user manuals, for instance). Finally, care should be taken to use the correct characters for naming these folders. We no longer live in a Windows 3 or even a Windows 95 world, we have Unicode. If the canonical name for a platform uses a colon or a slash (both of which are not permitted for file or directory names), the "full width" version of these can be used instead. Visually they are indistinguishable from the normal versions of those characters, but they cause none of the issues that using the ASCII versions would cause. For example: @@ -20,5 +17,4 @@ Finally, care should be taken to use the correct characters for naming these fol /IBM /OS／2 -These are only guidelines, however. Feel free to adjust and modify, and don't forget that you can go back and change something if it still doesn't feel or work right. And if you think you've got something really clever, consider offering it back to the rest of us here at https://github.com/roboyoshi/datacurator-filetree . - +These are only guidelines, however. Feel free to adjust and modify, and don't forget that you can go back and change something if it still doesn't feel or work right. And if you think you've got something really clever, consider offering it back to the rest of us here at [datacurator filetree](https://github.com/roboyoshi/datacurator-filetree). diff --git a/root/video/README.MD b/root/video/README.MD index 8d585f7..4b137c5 100644 --- a/root/video/README.MD +++ b/root/video/README.MD @@ -1,3 +1,5 @@ +# ./video + ## Content *There is a wide range of types:* @@ -6,11 +8,9 @@ Movies, Movie Shorts, Music Videos, Tv-Shows, Documentaries, learning/tutorials, The most important are probably Movies and TV-Shows -* Should not be splitted too far -* TV Shows and Anime ? Together in 1 Directory or splitted? -* TV Shows and Web-Series (Youtube Series, inofficial stuff) - splitted? - - +- Should not be splitted too far +- TV Shows and Anime ? Together in 1 Directory or splitted? +- TV Shows and Web-Series (Youtube Series, inofficial stuff) - splitted? ## Patterns @@ -18,8 +18,6 @@ The most important are probably Movies and TV-Shows → `Short Films` should be integrated into the `movies` folder, but can also be put into a seperate `movie-shorts` or `shorts` directory. If really necessary even `short-films` would work. - - ## Multiple Languages If you have movies in multiple languages you have a few options available: @@ -29,14 +27,10 @@ If you have movies in multiple languages you have a few options available: 3. Split them at the movie level (`'movies/The Movie (Year) [en]`', '`movies/The Movie (Year) [jp]`' 4. Split them at the higher level (`root/videos/german/{movies,tv..}`) - - This depends how many languages you maintain and how much work you want to put into this. Usually it is enough to have 1 folder `movies` with sub-folders of the actual movie title and then throw everything in there. - - ## Resources -- https://kodi.wiki/view/Naming_video_files/Movies +- [Kodi Movie Naming Schema](https://kodi.wiki/view/Naming_video_files/Movies) -- https://support.plex.tv/articles/categories/media-preparation/ +- [Plex Media Preperation](https://support.plex.tv/articles/categories/media-preparation/) diff --git a/root/video/discs/README.MD b/root/video/discs/README.MD index 446374a..3e19bec 100644 --- a/root/video/discs/README.MD +++ b/root/video/discs/README.MD @@ -2,13 +2,11 @@ > This is plain DVD/BD Dumps of Movies/Series/Documentaries/etc. - - ## Naming DVD Examples: -``` +```md # Movies: Constantine.2005.COMPLETE.PAL.DVD9-GRP Pets.2016.COMPLETE.PAL.DVD9-GRP @@ -23,7 +21,7 @@ Eine.Schrecklich.nette.Familie.S01.DiSC1.GERMAN.MULTi.PAL.DVD9-GRP BluRay Examples: -``` +```md # Scene: Die.Unglaublichen.2004.MULTi.COMPLETE.BLURAY-GRP Fantastic.Mr.Fox.2009.NORDiC.COMPLETE.BLURAY-GRP @@ -46,10 +44,7 @@ This is obviously a personal preference, but whatever you decide for, try to sti **Files and Formats:** -* A copy of `VIDEO_TS/AUDIO_TS` (DVD) or `BDMV` (BluRay) -* A backup image of the disc as `*.iso/*.img` - - +- A copy of `VIDEO_TS/AUDIO_TS` (DVD) or `BDMV` (BluRay) +- A backup image of the disc as `*.iso/*.img` ## References - diff --git a/root/video/movies/README.md b/root/video/movies/README.md index 798279f..19d16b2 100644 --- a/root/video/movies/README.md +++ b/root/video/movies/README.md @@ -1,7 +1,8 @@ # Naming Scheme Naming scheme can be as follows: -``` + +```md MovieTitle (Year) {Identifier} / ├── MovieTitle (Year) {Identifier}.mkv ├── MovieTitle (Year).[language code].srt @@ -10,14 +11,15 @@ MovieTitle (Year) {Identifier} / ``` Example: -``` + +```md Avatar (2009)/ ├── Avatar (2009).mkv ├── Avatar (2009).en.srt └── cover.jpg ``` -# Resources +## Resources -- https://support.plex.tv/articles/naming-and-organizing-your-movie-media-files/ -- https://support.plex.tv/articles/200220677-local-media-assets-movies/ +- [Naming and organizing your Movie files](https://support.plex.tv/articles/naming-and-organizing-your-movie-media-files/) +- [Local Media Assets – Movies](https://support.plex.tv/articles/200220677-local-media-assets-movies/) diff --git a/root/video/tv-anime/README.md b/root/video/tv-anime/README.md index 0c6f90f..d244f94 100644 --- a/root/video/tv-anime/README.md +++ b/root/video/tv-anime/README.md @@ -2,26 +2,22 @@ > Since anime often follows the season/cour pattern, it can be split off into it's own section here. - - ## Naming This can be handled at will, we currently do not provide a proper structure for this. What I can recommend though is aggregating the releases into one main folder for the series and putting all batches/cours into that. -``` +```md Main Anime Aggregate/ - Individual Seasons/Cours/Releases + Individual Seasons/Cours/Releases ``` for example: -``` +```md Attack on Titan/ - Shingeki no Kyojin S3 (38-49) [1080p] - Shingeki no Kyojin S3 (50-59) [1080p] - Attack.on.Titan.BD.1080p.DL.DTS.x264-GRP - + Shingeki no Kyojin S3 (38-49) [1080p] + Shingeki no Kyojin S3 (50-59) [1080p] + Attack.on.Titan.BD.1080p.DL.DTS.x264-GRP ``` - diff --git a/root/video/tv-shows/README.MD b/root/video/tv-shows/README.MD index b2e76a4..9fce965 100644 --- a/root/video/tv-shows/README.MD +++ b/root/video/tv-shows/README.MD @@ -1,18 +1,17 @@ -## TV-Shows +# TV-Shows **Things to consider:** -* Merging TV Series with *Anime* and *Animated* Content (aka *Cartoons*, since they both are broadcasted on national TV, as well as on VOD Services. -* Internationalized Names vs. Localized Names ('Shingeki No Kyojin' vs 'Attack on Titan') -* CAN be split further if people like to split their libraries. (Anime/Cartoon/TV/Kids/..) -* Appending Years is almost always a good Idea (as with movies) - there might be multiple variants.. (Matching with DB seems to be a bit off though..) - +- Merging TV Series with *Anime* and *Animated* Content (aka *Cartoons*, since they both are broadcasted on national TV, as well as on VOD Services. +- Internationalized Names vs. Localized Names ('Shingeki No Kyojin' vs 'Attack on Titan') +- CAN be split further if people like to split their libraries. (Anime/Cartoon/TV/Kids/..) +- Appending Years is almost always a good Idea (as with movies) - there might be multiple variants.. (Matching with DB seems to be a bit off though..) There is a good reason why Anime is often split - because the Naming differs in a kinda uncomfortable way. See Attack on Titan For Example - Season 2 is actually considered a new Series and Just named as "season 2". But at the Same Time the Episode Count just keeps going up instead of being reset. Sherlock on the other Hand has a Classic Season / Episode Structure that is much easier to follow. -* We need to find a structure that either sqauashes one into the other, or keep it seperate. +- We need to find a structure that either sqauashes one into the other, or keep it seperate. ---- @@ -28,8 +27,6 @@ Still talking about the United States ... A television "series" is all of the sh In the UK, the terminology is different. They use "series" to mean what we in the US would probably call "seasons." In the UK they'd say that Lady Mary had a baby in "Series Three" of Downton Abbey. In the US, we'd say that Lady Mary had the baby in "Season Three." - - | Naming | EU/UK | US | JP (Anime) | | ------------------------ | -------- | ------- | ----------------------------- | | The whole thing | Programs | Shows | Tv-Shows | @@ -38,9 +35,6 @@ In the UK, the terminology is different. They use "series" to mean what we in th > Program is usually also the daily schedule of the broadcasting station. - - ## References -- https://www.quora.com/What-is-the-difference-between-a-TV-series-and-a-TV-show - +- [What is the difference between a TV series and a TV show?](https://www.quora.com/What-is-the-difference-between-a-TV-series-and-a-TV-show) diff --git a/root/video/web/README.md b/root/video/web/README.md index 3b7a0b2..8d9797a 100644 --- a/root/video/web/README.md +++ b/root/video/web/README.md @@ -1,3 +1,3 @@ # Web -> Videos from youtube, vimeo, etc. \ No newline at end of file +> Videos from youtube, vimeo, etc.