-
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update README to not show "in progress" stuff
- Loading branch information
1 parent
7733a0d
commit 5570d9c
Showing
1 changed file
with
3 additions
and
23 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,30 +1,10 @@ | ||
[raypeat.rodeo](https://raypeat.rodeo) is the open-source effort to transcribe | ||
the public works of Ray Peat. | ||
|
||
You are looking at the `rust` git branch: an in progress reimplementation of | ||
the Ray Peat Rodeo golang codebase in Rust. | ||
|
||
# Reimplement | ||
|
||
- [x] modd/devd development environment | ||
- [x] HTML Templating | ||
- [ ] Parse transcripts from Markdown to HTML | ||
- [x] Standard Markdown parsing | ||
- [x] Block interview syntax | ||
- [x] Sidenotes | ||
- [x] Inline citations | ||
- [x] People | ||
- [x] Books | ||
- [x] ISBN | ||
- [x] External Links | ||
- [ ] Citation metadata scraping | ||
- [x] Timecodes | ||
- [ ] Images and assets | ||
- [ ] Pagefind static search | ||
|
||
# Usage | ||
|
||
```bash | ||
nix develop -c serve # build and serve site over HTTP (auto-reloads) | ||
nix run # build Ray Peat Rodeo to ./build | ||
nix run # build Ray Peat Rodeo to ./build | ||
nix develop -c watch # Build on change to source code | ||
nix develop -c watch-and-serve # as above + serve site over HTTP | ||
``` |