https://github.com/rsdc2/biblereader
https://github.com/rsdc2/biblereader
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/rsdc2/biblereader
- Owner: rsdc2
- License: mit
- Created: 2025-02-26T16:21:00.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2025-03-04T17:03:53.000Z (over 1 year ago)
- Last Synced: 2025-03-04T18:20:29.474Z (over 1 year ago)
- Language: C#
- Size: 190 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# BibleReader
This Windows application displays Bible files saved in the [`.usx` XML-based file format](https://markups.paratext.org/usx/).
*Tyndale's translation of Matthew in BibleReader (translation from [fetch.bible](https://fetch.bible/content/bibles/))*
BibleReader is in beta.
## Features
- **Formatted display**: displays a `.usx` file formatted as you might find it in a Bible
- **XML display**: displays the underlying XML of a `.usx` file
Formatted and XML display modes may be toggled by pressing the `XML` button in the reader.
## Development environment and running requirements
*BibleReader* is written in C# (.NET Core 8). The GUI is written with [WPF](https://learn.microsoft.com/en-us/dotnet/desktop/wpf/overview/?view=netdesktop-9.0). To run the application, you will need:
- Windows
- .NET runtime
### Build and run
1. Download or clone the repository
2. ```cd BibleReader```
3. ```dotnet run```
### Run the tests
1. Download or clone the repository
2. ```cd BibleReader.Tests```
3. ```dotnet test```
## Implementation details
### `.usx` file format
At present *BibleReader* implements the following subset of the `.usx` elements in the specification:
- ``
- ``
- ``
- ``
- ``
- ``
The following `@style` values are supported:
- `mt1`: main title 1
- `h`: heading
- `id`: for book titles
- `c`: for chapter numbers
- `v`: for verse numbers
- `p`: for paragraph text
## Acknowledgements
### Dependencies
The test project `BibleReader.Tests` relies on [NUnit](https://github.com/nunit/nunit) ([MIT](https://github.com/nunit/nunit?tab=MIT-1-ov-file#readme)).
### Further information
- USX specification: [https://markups.paratext.org/usx/](https://markups.paratext.org/usx/)
- Windows Presentation Foundation: [https://learn.microsoft.com/en-us/dotnet/desktop/wpf/overview/?view=netdesktop-9.0](https://learn.microsoft.com/en-us/dotnet/desktop/wpf/overview/?view=netdesktop-9.0)