Skip to content

Commit

Permalink
docs: edit contributing, how to build (#5163)
Browse files Browse the repository at this point in the history
  • Loading branch information
maciej-ka authored Oct 30, 2024
1 parent d19c7b0 commit a7068ea
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions CONTRIBUTING.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -90,26 +90,26 @@ addition or not.

## Building the site locally

Install Ruby, on macOS you can do it by installing [Homebrew](https://brew.sh/) then
Install Ruby. On macOS this can be done with [Homebrew](https://brew.sh/).

```sh
brew install ruby
# Install Ruby package manager
gem install bundler
```

then
Then clone two repos, install dependencies and run.

```sh
# Install Ruby bundler
gem install bundler

# Clone the repo for the website
# Clone website
git clone https://github.com/adambard/learnxinyminutes-site
# and clone the repo with all the content (this repo) into it
# Clone docs (this repo) nested in website
git clone https://github.com/<YOUR-USERNAME>/learnxinyminutes-docs ./learnxinyminutes-site/source/docs/

# Install the dependencies and run the site
# Install dependencies
cd learnxinyminutes-site
bundle install

# Run
bundle exec middleman serve
```

0 comments on commit a7068ea

Please sign in to comment.