Skip to content
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

Jump to bottom

README: update instructions #631

Merged
merged 1 commit into from
Jun 13, 2024
Merged

README: update instructions #631

Show file tree
Hide file tree
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
2 changes: 1 addition & 1 deletion .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,4 @@ Gemfile.lock
# Exclude the generated site files
docs/
!docs/_config.yml
!docs/CNAME
!docs/CNAME
4 changes: 3 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,14 @@ A [GitHub Action](https://github.com/Homebrew/rubydoc.brew.sh/blob/master/.githu

Open <https://rubydoc.brew.sh> in your web browser.

To instead run Homebrew RubyDoc locally, run:
To instead run Homebrew RubyDoc locally at <http://localhost:4000>, run:

```bash
git clone https://github.com/Homebrew/rubydoc.brew.sh
cd rubydoc.brew.sh
bundle install
ln -s $(brew --repo) brew
bundle exec rake yard
bundle exec jekyll serve --source docs
```

Expand Down