Update readme files for consistency/ext. (#36)

- update main readme - simplified images readme - updated video readme - update documents readme - minor corrections as well as updates to the resources section - general consistency changes and removing unnecessary blank lines
roboyoshi · Sep 6, 2019 · e8694bc · e8694bc
1 parent 8e0dd20
commit e8694bc
Show file tree

Hide file tree

Showing 9 changed files with 21 additions and 170 deletions.
diff --git a/README.md b/README.md
@@ -1,9 +1,10 @@
 # filetree
-A FileTree for r/datacurator
 
-Hello and Welcome to the [r/datacurator](https://reddit.com/r/datacurator) filetree repository.  
+A filetree for r/datacurator
 
-We aim to create a unified filetree for all kinds of data.
+Hello and welcome to the [r/datacurator](https://reddit.com/r/datacurator) filetree repository.
+
+We aim to create a unified filetree for all kinds of data, which should help in storing, categorising and retrieving.
 
 ---
 

diff --git a/root/audio/README.MD b/root/audio/README.MD
@@ -1,11 +1,9 @@
 ## Content
 
-The (digital) audio section contains any kind of sound that is contained within a file - such as music, sounds, sound-fx, podcasts, audiobooks, event recordings (musicals, concerts, standup comedy), games and many others.
+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.
 
 Some common file types are: `*.{raw,wav,flac,mp3,m4a,m4b,ogg,opus,aiff,aac}`
 
-
-
 ## Sub-Sections
 
 | Folder       | Contents                                                     |
@@ -17,16 +15,12 @@ Some common file types are: `*.{raw,wav,flac,mp3,m4a,m4b,ogg,opus,aiff,aac}`
 | podcasts     | audio-only broadcasts.. alternative name: `netcast`          |
 | soundtracks  | audio content related to other media like movies, tv-shows and videogames |
 
-
-
 ## Patterns
 
-File Naming among music files is a very common topic among enthusiasts and it differs a lot from person to person. The filetree itself already defines a certain pattern that many people can somewhat agree on.
+File naming among music files is a very common topic among enthusiasts and it differs a lot from person to person. The filetree itself already defines a certain pattern that many people can somewhat agree on.
 
 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:
 
-
-
 ```
 # + --------------------------------------------------------------------------------
 # | Music
@@ -49,10 +43,9 @@ ALBUM_ARTIST/ALBUM_ARTIST - ALBUM (YEAR) [FORMAT]/CD N/TRACKNR - ARTIST - TRACKT
 # + -------------------------------------------
 ```
 
-
-
 ## Resources
 
-- https://musicbrainz.org/
-- https://www.discogs.com/
-- https://hydrogenaud.io/
+- 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.
diff --git a/root/documents/README.md b/root/documents/README.md
@@ -1,27 +1,24 @@
 ## Content
 
-Personal Documents like Letters, Poems, Forms, Bills, etc.
-
-
+Personal documents like letters, poems, forms, bills, etc.
 
 ## Sub-Sections
 
 → User defined.
 
-
-
 ## Patterns
 
+One of the most common file naming schemes is the use of the date in ISO8601 format at the start of the name (i.e YYYY-MM-DD) followed by a dash and then a useful name for the file. These names should be appropriately descriptive and formatted in an easily readable manner that allow it to be distinguished from other documents in the same subsection.
 
+### Examples
+
+> 2019-09-01 - August 2019 Utilities Bill.pdf
 
 ```
 # 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/
-
diff --git a/root/games/README.MD b/root/games/README.MD
@@ -1,21 +1,13 @@
 ## Content
 
-
-
 ## Sub-Sections
 
-
-
 ## Patterns
 
-
-
 ## Resources
 
-
-
 ## Notes
 
 * Games =! VideoGames
 * There is boardgames, cardgames, etc..
-* how to group? currently grouped as 'interactive'
+* how to group? currently grouped as 'interactive'
diff --git a/root/images/README.md b/root/images/README.md
@@ -1,6 +1,6 @@
 ## Content
 
-Images may include, but is not limited to: 
+Images may include, but is not limited to:
 
 | Category | Description |
 |----------|-------------|
@@ -12,106 +12,6 @@ Images may include, but is not limited to:
 | Purpose-based | Subcategories of types of images that are used for a specific purpose
 | Screenshots  | Digital images of what appears on a screen           |
 
-## Sub-Sections
-
-### Animated
-
-### Artwork
-
-Images of things created by people for aesthetic purposes
-
-  - #### Digital Art
-
-  - #### Drawings
-
-  - #### Logos
-
-  - #### Paintings
-
-  - #### Sculpture
-
-### Charts
-
-Images of data represented graphically
-
-  - #### Area charts
-
-  - #### Bar charts
-
-  - #### Bubble charts
-
-  - #### Flowcharts
-
-  - #### Infographics
-
-  - #### Line charts
-
-  - #### Maps
-
-  - #### Matrices
-
-  - #### Mind maps
-
-  - #### Miscellaneous
-
-  - #### Organizational charts
-
-  - #### Pie charts
-
-  - #### Sankey diagrams
-
-  - #### Spiral diagrams
-
-  - #### Treemaps
-
-  - #### Venn diagrams
-
-  - #### Wordclouds
-
-### Memes
-
-### Photos
-
-  - #### Friends' and Family Photos
-
-  - #### Other Photos
-
-  - #### Personal Photos
-
-### Purpose-based
-
-  - #### Archives
-
-    - ##### Instagram archives
-
-  - #### Profile pics
-
-  - #### Video games
-
-  - #### Wallpapers
-
-### Screenshots
-
-  - #### 4chan
-
-  - #### Discord
-
-  - #### Facebook
-
-  - #### iMessage
-
-  - #### Instagram
-
-  - #### Reddit
-
-  - #### Snapchat
-
-  - #### Twitter
-
-  - #### WhatsApp
-
-  - #### YouTube
-
 ## Patterns
 
 TODO

diff --git a/root/literature/README.MD b/root/literature/README.MD
@@ -9,25 +9,17 @@
 - Manifestos
 - Short Stories
 
-
-
 ## Sub-Sections
 
 → 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)
 
-
-
 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
@@ -40,8 +32,6 @@ I'd advise to unpack all and go through them real quick, then choose one of the
 	└── 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)

diff --git a/root/software/README.MD b/root/software/README.MD
@@ -1,23 +1,15 @@
 ## Content
 
-
-
 ## Sub-Sections
 
-
-
 ## Patterns
 
-
-
 ## Resources
 
-
-
 ## Notes
 
 * Software can be more than just PC (x86/x64)
 * Should also include "retro"-software
 * CAN include games?
 * How to treat open-source software - is that more of a project?
-* Sub-Divide by version? Put all in 1 Folder? Keep Name of original release?
+* Sub-Divide by version? Put all in 1 Folder? Keep Name of original release?
diff --git a/root/video/README.MD b/root/video/README.MD
@@ -1,33 +1,25 @@
 ## Content
 
-*There is a wide range of Video-types:*
+*There is a wide range of types:*
 
-Movies, Movie Shorts, Music Videos, Tv-Shows, Documentaries, learning/tutorials, webisodes, dvd extras (making of), real-live captures, vlogs, let's play, and more..  
+Movies, Movie Shorts, Music Videos, Tv-Shows, Documentaries, learning/tutorials, webisodes, dvd extras (making of), real-live captures, vlogs, let's plays, and more..  
 
 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?
 
-
-
 ## Sub-Sections
 
-
-
 ## Patterns
 
-→ Currently we Use 'movies' because it's more widely adapted instead of 'film'
+→ Currently we use 'movies' because it's more widely adapted instead of 'film'
 
 → `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.
 
-
-
 ## Resources
 
 - https://kodi.wiki/view/Naming_video_files/Movies
 
 - https://support.plex.tv/articles/categories/media-preparation/
-
-
diff --git a/root/web/README.MD b/root/web/README.MD
@@ -2,18 +2,12 @@
 
 Basically snapshots/dumps/rips of a given website/webapp bound to a point in time.
 
-
-
 ## Sub-Sections
 
 → High Level Domains which then contain raw dumps of a webpage, ideally seperated by a timestamp.
 
-
-
 ## Patterns
 
-
-
 ## Resurces
 
 - https://archive.org/