Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
pmbauer committed May 26, 2021
1 parent 432938d commit ad17cc6
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 14 deletions.
20 changes: 6 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
# av-roam
Generates a King James ([Authorized Version](https://en.wikipedia.org/wiki/King_James_Version)) text that is formatted for import into a [Roam Research](https://roamresearch.com/) database.
# av-obsidian
Generates a King James ([Authorized Version](https://en.wikipedia.org/wiki/King_James_Version)) text that is formatted for import into an [Obsidian](https://obsidian.md/) vault.

It uses Roam markdown and [LaTeX](https://en.wikipedia.org/wiki/LaTeX) features to approximate the original print as much as possible.
It uses Obsidian markdown and [LaTeX](https://en.wikipedia.org/wiki/LaTeX) features to approximate the original print as much as possible.

![note italicized words, section headers, and special treatment of YHWH](doc/example.png)

## Features

1. One chapter per note, one verse per block.
1. Navigational metadata: *Previous/Next* chapter links and `#<Book>` tags
1. One chapter per note, one verse per line.
1. Navigational links: *Previous/Next* chapter links.
1. _italicized_ words to indicate translation additions
1. _YHWH_ formatted LORD as in the original print
1. original print paragraph markings and chapter notes
Expand All @@ -18,15 +18,7 @@ It uses Roam markdown and [LaTeX](https://en.wikipedia.org/wiki/LaTeX) features
## Usage

1. [Download the current release](https://github.com/pmbauer/av-roam/releases/download/c10dc89/av-roam_c10dc89.tar.gz) and extract locally
2. Use Roam Research `...` menu and select `Import Files`
3. Choose chapters you wish to import.

## Import Everything
Note that importing a corpus as large as the entire Bible *will* impact your database's performance, so for now it's recommended to import chapters ad-hoc.

But if you still wish to import everything, there is a [public KJV Roam](https://roamresearch.com/#/app/KJV).
From there you can JSON-export the contents and import into your personal database.
N.B. that version is missing a number of features from the original AV translation: _italicized_ words to indicate translation word additions, footnotes, chapter and section headings (e.g. Psalms 119)
2. Copy `av` into your obsidian vault.

## Building
```bash
Expand Down
Binary file modified doc/example.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit ad17cc6

Please sign in to comment.