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

updated readme

Browse Source
This commit is contained in:
dan 2024-08-29 19:33:01 -05:00
parent d79f2658d4
commit 677f430dd5
3 changed files with 85 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
.README.md.un~ Normal file
View File

Binary file not shown.

17
README.md
View File

@ -13,9 +13,7 @@ Instructions:
## installation
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:
Bibliofile is an ncurses-inspired ebook reader for the terminal written in Rust! There is a release available, but if you wish, you can customize the code and follow the build instructions below:
### 1
@ -34,20 +32,21 @@ I have uploaed the crate to crates.io since it is in a minimally-workable state
Clone the repository to the directory of your choice
```git
git clone https://git.whoisthisjoker.com/daniel/bibliofile
git clone https://gitea.whoisthisjoker.com/danjoredd/bibliofile
```
### 3
cd into the directory *bibliofile*. Compile the program. This is best done with cargo.
you will need at least Cargo 1.60 to compile, as of August 2024.
```rust
cargo build
cargo build --release
```
The executable will be in target/debug.
Please keep in mind, at this point in development compilation success is not guaranteed.
## running
@ -58,10 +57,6 @@ cd into the directory *bibliofile*. Compile the program. This is best done with
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 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
Bibliofile: A TUI epub reader inspired by DOS-era programs

79
README.md~ Normal file
View File

@ -0,0 +1,79 @@
# Bibliofile
### A TUI-based ebook reader inspired by NCurses-era programs!
Bibliofile is a simplified epub reader with automatic bookmarking!
Instructions:
- installation
- use
- feedback
## installation
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
Install Rust. The full Instructions on how to do this are here: https://www.rust-lang.org/tools/install
The easiest way of installing Rust is with the following command:
```bash
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
```
### 2
Clone the repository to the directory of your choice
```git
git clone https://git.whoisthisjoker.com/daniel/bibliofile
```
### 3
cd into the directory *bibliofile*. Compile the program. This is best done with cargo.
```rust
cargo build
```
The executable will be in target/debug.
Please keep in mind, at this point in development compilation success is not guaranteed.
## running
Running the program is simple, as at this point there is not many features. Simply run
```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 are not yet any keyboard commands to turn pages, but that is the next feature I mean to implement.
## disclamers
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
Bibliofile: A TUI epub reader inspired by DOS-era programs
Copyright (C) 2023 Daniel Redd joes
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.