Skip to content

Fix typos in README setup instructions #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
willf wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Fix typos in README setup instructions #1

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b831444
Fix typos in README setup instructions
willf Jun 18, 2026
6fdb82b
Clarify Go installation requirements in README
willf Jun 18, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 6 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,23 +116,24 @@ lot. Apologies...
### Setup

1. You need to install Go. Do that according to [these
direction](https://go.dev/doc/install).
directions](https://go.dev/doc/install). It's probably best if you
have the latest version of Go, but it needs to be at least Go 1.24.

2. You need to have a working terminal with git. I haven't tested this
3. You need to have a working terminal with git. I haven't tested this
on Macs but it should be fine. There's nothing keeping this from
working on Windows, particularly WSL, but I know less of the
details.

Open the terminal and run the `git` command. If it prints a bunch
of stuff that starts with `usage` then you're good.

3. Clone the repository and the submodule with the following command:
4. Clone the repository and the submodule with the following command:

```bash
git clone https://github.com/tychoish/odem.git --recursive-submodules
git clone https://github.com/tychoish/odem.git --recurse-submodules
```

The `--recursive-submodules` option downloads the database from
The `--recurse-submodules` option downloads the database from
Mark's repository and gets it all set up. If you omit this option
above or clone the repository in another way, and you don't have
the datebase (run `ls pkg/db/fasoladb` to check), you can setup the
Expand Down