Skip to content

Update README instructions #9

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

Merged
merged 1 commit into from
Mar 4, 2025
Merged

Update README instructions #9

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 4 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@ Diataxis is a command-line tool for managing documentation following the [Diatax
Install the gem by executing:

```bash
git clone https://github.com/gavindidrichsen/diataxis.git
cd diataxis
gem install diataxis
```

Expand Down Expand Up @@ -48,6 +50,8 @@ If you change any document titles, then run the following to automatically renam
dia update .
```

For more information including design decisions and how-to's see [docs/README.md](./docs/README.md).

## Development

After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
Expand Down
Loading