https://github.com/pyrestudios/berry
Your digital (li)berry (Library)
https://github.com/pyrestudios/berry
Last synced: about 1 year ago
JSON representation
Your digital (li)berry (Library)
- Host: GitHub
- URL: https://github.com/pyrestudios/berry
- Owner: PyreStudios
- Created: 2024-05-01T02:20:04.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-06-13T02:48:12.000Z (about 2 years ago)
- Last Synced: 2024-07-15T07:59:58.676Z (almost 2 years ago)
- Language: Go
- Size: 4.88 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# Berry
Your own personal little Li-berry. A media server for digital reading -- comics, books, pdfs.
Disclaimer: Everything under this line is the pipe-dream -- this does not work as is today, but this is what we're building towards.
## Setup
TODO: Add installation instructions for Berry, ideally including Docker, native Go, and a binary version.
A configuration file is used by Berry to help kickstart your media server and manage it's configuration. The configuration file is written in Yaml and you'll want to give your server a name and specify a list of "media_roots". These are root folders that you can store your media. Each root should follow the following structure (let's assume my "M" drive is my media root):
TODO: Does this structure make sense?
```
M:
| > comics
| | > Marvel (this is a publisher)
| | | > Iron Man (this is a comic series)
| | | | > 44 (this is the series number)
| | | | | > iron_man_44.pdf (whatever the name of the file is)
| | | | | > iron_man_44_cover.jpg (the cover image for this comic)
| > books
| | > Henry James (this is an author)
| | | > The Portrait of a Lady (this is a book)
| | | | > portrait.epub (whatever the name of the file is)
| | | | > portrait_cover.jpg (the cover image for this book)
```