book/README.md

55 lines
1.3 KiB
Markdown

# book
<p align="center">
<img alt="Static Badge" src="https://img.shields.io/badge/Literary_License-CC_BY_NC_SA-green">
<img alt="Static Badge" src="https://img.shields.io/badge/Software_License-MIT-maroon">
<img alt="GitHub commit activity (branch)" src="https://img.shields.io/github/commit-activity/t/firebadnofire/book">
<img alt="repo size" src="https://img.shields.io/github/repo-size/firebadnofire/book">
</p>
The Future's Relic is a thrilling book about a time travling man getting stuck in a time which he is unfamillier with. Through his limmited knowledge of this time and the people he meets,
can he successfuly return to his own time?
# How to read this
```
This has only been tested on Linux.
This has not been tested on Windows or Mac.
```
Download the code and book:
```
git clone https://codeberg.org/firebadnofire/book.git
```
Run the reader program
```
python3 reader.py
```
Controls:
left/right: change chapter
up/down: scroll
q: quit
# License
The code has been licensed under the MIT license
Literary license:
The Future's Relic (c) by firebadnofire
The Future's Relic is licensed under a
Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License.
You should have received a copy of the license along with this
work. If not, see <https://creativecommons.org/licenses/by-nc-sa/4.0/>.