Skip to content

Commit

Permalink
Update README to not show "in progress" stuff
Browse files Browse the repository at this point in the history
  • Loading branch information
marcuswhybrow committed Oct 3, 2023
1 parent 7733a0d commit 5570d9c
Showing 1 changed file with 3 additions and 23 deletions.
26 changes: 3 additions & 23 deletions README.md
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
```

0 comments on commit 5570d9c

Please sign in to comment.