royal_road_archiver/README.md

### Terminal based archival Program for RoyalRoad.
#### Currently supports:
* Epub generation - Turn the webnovels into an epub file for offline reading / archival.
* Markdown generation - Turn the webnovels into a markdown file. ~~Dunno why you'd want to do this but hey, you can.~~

#### Coming soon:
* Audiobook generation support.
* HTML + CSS archival. Think archive.org, but on your machine.

### How to use:
* Windows - Download the binaries (.exe files) for windows from the [releases page,](https://github.com/Raine-gay/royal_road_archiver/releases)    
  Unzip them into a folder E.G Downloads,  
  Open Command prompt,  
  Change the directory to where you unzipped the binaries (.exe files) by typing ``cd <Binaries_Directory>\royal_road_archiver_windows-bin`` E.G ``cd Downloads\royal_road_archiver_windows-bin``,  
  Open the program by typing ``royal_road_archiver.exe``

* Linux - Basically the same as windows:  
  Download the linux binaries from the [releases page,](https://github.com/Raine-gay/royal_road_archiver/releases)  
  Unzip em,  
  Open console,  
  ``cd`` to the folder containing the binaries,  
  Run it using ``royal_road_archiver``  
  
* Cargo - Run ``cargo install royal_road_archiver``,  
  Then just run ``royal_road_archiver`` from the terminal.  
  **DOES NOT WORK ON WINDOWS.**  

### Example commands:
* ``royal_road_archiver https://www.royalroad.com/fiction/59450/bioshifter epub`` --- Will create an Epub version of the novel bioshifter in the current directory.  
* ``royal_road_archiver https://www.royalroad.com/fiction/59450/bioshifter markdown --no-image-tags`` --- Will create a markdown version of the novel bioshifter in the current directory, removing image tags from the markdown file.
* ``royal_road_archiver https://www.royalroad.com/fiction/59450/bioshifter Downloads epub`` --- Will create an Epub version of the novel bioshifter in my Downloads folder.
* Look the commands are all documented in the program just running ``royal_road_archiver help`` will show you everything.

Enjoy.
Update README.md 2024-01-26 23:18:47 +00:00			`### Terminal based archival Program for RoyalRoad.`
Create README.md 2024-01-26 22:16:53 +00:00			`#### Currently supports:`
			`* Epub generation - Turn the webnovels into an epub file for offline reading / archival.`
			`* Markdown generation - Turn the webnovels into a markdown file. ~~Dunno why you'd want to do this but hey, you can.~~`

Fixed typos 2024-01-26 22:22:02 +00:00			`#### Coming soon:`
Create README.md 2024-01-26 22:16:53 +00:00			`* Audiobook generation support.`
			`* HTML + CSS archival. Think archive.org, but on your machine.`

			`### How to use:`
Update README.md 2024-01-28 18:26:18 +00:00			`* Windows - Download the binaries (.exe files) for windows from the [releases page,](https://github.com/Raine-gay/royal_road_archiver/releases)`
Create README.md 2024-01-26 22:16:53 +00:00			`Unzip them into a folder E.G Downloads,`
			`Open Command prompt,`
Update README.md 2024-01-26 22:41:43 +00:00			Change the directory to where you unzipped the binaries (.exe files) by typing ``cd <Binaries_Directory>\royal_road_archiver_windows-bin`` E.G ``cd Downloads\royal_road_archiver_windows-bin``,
Fixed typos 2024-01-26 22:22:02 +00:00			Open the program by typing ``royal_road_archiver.exe``
Create README.md 2024-01-26 22:16:53 +00:00
Update README.md 2024-01-26 23:17:19 +00:00			`* Linux - Basically the same as windows:`
Update README.md 2024-01-28 18:26:18 +00:00			`Download the linux binaries from the [releases page,](https://github.com/Raine-gay/royal_road_archiver/releases)`
Update README.md 2024-01-26 23:17:19 +00:00			`Unzip em,`
			`Open console,`
			``cd`` to the folder containing the binaries,
			Run it using ``royal_road_archiver``
Update README.md 2024-01-26 22:41:43 +00:00
			* Cargo - Run ``cargo install royal_road_archiver``,
			Then just run ``royal_road_archiver`` from the terminal.
Fixed typo 2024-01-27 15:44:16 +00:00			`DOES NOT WORK ON WINDOWS.`
Create README.md 2024-01-26 22:16:53 +00:00
			`### Example commands:`
			* ``royal_road_archiver https://www.royalroad.com/fiction/59450/bioshifter epub`` --- Will create an Epub version of the novel bioshifter in the current directory.
			* ``royal_road_archiver https://www.royalroad.com/fiction/59450/bioshifter markdown --no-image-tags`` --- Will create a markdown version of the novel bioshifter in the current directory, removing image tags from the markdown file.
			* ``royal_road_archiver https://www.royalroad.com/fiction/59450/bioshifter Downloads epub`` --- Will create an Epub version of the novel bioshifter in my Downloads folder.
			* Look the commands are all documented in the program just running ``royal_road_archiver help`` will show you everything.

			`Enjoy.`