From e735ef7869b3eaa815eebd18311dbb053d24f141 Mon Sep 17 00:00:00 2001 From: Mark Cooper Date: Sat, 18 Sep 2021 12:49:21 -0500 Subject: [PATCH] Readme update --- readme.md | 17 +++++++---------- 1 file changed, 7 insertions(+), 10 deletions(-) diff --git a/readme.md b/readme.md index f8daf3ee..77c8d15c 100644 --- a/readme.md +++ b/readme.md @@ -9,7 +9,7 @@ Android app is in beta, try it out on the [Google Play Store](https://play.googl Screenshot1 -### Directory Structure +## Directory Structure Author, Series, Volume Number, Title and Publish Year can all be parsed from your folder structure. @@ -19,14 +19,12 @@ Author, Series, Volume Number, Title and Publish Year can all be parsed from you **2 Folders:** `/Author/Title/...`\ **3 Folders:** `/Author/Series/Title/...` -\ -**Parsing publish year** +### Parsing publish year `/1984 - Hackers/...`\ Will save the publish year as `1984` and the title as `Hackers` -\ -**Parsing volume number** (only if there is a series folder) +### Parsing volume number (only for series) `/Book 3 - Hackers/...`\ Will save the volume number as `3` and the title as `Hackers` @@ -38,20 +36,19 @@ These combinations will also work:\ `/1984 - Volume 3 - Hackers/...`\ `/1984 - Hackers Book 3/...` -\ -**Parsing book subtitles** (optional in settings) + +### Parsing subtitles (optional in settings) Title Folder: `/Hackers - Heroes of the Computer Revolution/...` Will save the title as `Hackers` and the subtitle as `Heroes of the Computer Revolution` -\ -**Full example** + +### Full example `/Steven Levy/The Hacker Series/1984 - Hackers - Heroes of the Computer Revolution - Vol. 1/...` Becomes:\ - | Author | Steven Levy | |---------------|-----------------------------------| | Series | The Hacker Series |