danjoredd/bibliofile
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 1 Wiki Activity

updated documentation to get ready to publish to crates.io

Browse Source
This commit is contained in:
Daniel Jones 2023-11-20 08:49:44 -06:00
parent c0c02ba073
commit a5400a841e
2 changed files with 15 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
Cargo.toml
View File

@ -2,7 +2,15 @@
name = "bibliofile"
version = "0.1.0"
edition = "2021"
licence-file = "LICENSE"
description = "A TUI epub reader inspired by DOS-era programs"
readme="README.md"
documentation = "https://git.whoisthisjoker.com/Daniel/bibliofile#bibliofile"
keywords = ["ebook", "epub", "reader", "ebook reader", "termion", "TUI", "tui"]
category = ["parsing", "command-line-utilities"]
authors = ["Daniel Jones <daniel@whoisthisjoker.com>"]
rust-version = "1.73"
repository = "https://git.whoisthisjoker.com/Daniel/bibliofile"
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
[dependencies]

9
README.md
View File

@ -13,7 +13,10 @@ Instructions:
## installation
At the moment, Bibliofile is a work-in-progress, so it is not part of any package manager, and no binaries are available at the moment. However to run this while in alpha, you can follow the Instructions down below.
At the moment, Bibliofile is a work-in-progress.
I have uploaed the crate to crates.io since it is in a minimally-workable state at the moment, but if you wish to compile it yourself simply follow these directions:
### 1
@ -52,12 +55,12 @@ cd into the directory *bibliofile*. Compile the program. This is best done with
```bibliofile [booknamehere.epub]```
There will be buttons at the bottom of each page that allow you to turn pages. Simply press "last" or "next" to turn the page.
There will be buttons at the bottom of each page that allow you to turn pages. Simply press "last" or "next" to turn the page. There are not yet any keyboard commands to turn pages, but that is the next feature I mean to implement.
## disclamers
This program is in alpha, and I am trying to get base functionality working. It will be lacking features, and can currently only read epub files. Mobi and PDF are not supported.
This program is incomplete. It will be lacking features such s searching text, skipping pages, and using the table of contents. I update this program regularly, so stay tuned!
## license