Skip to content

Commit

Permalink
add to readme contributing section
Browse files Browse the repository at this point in the history
  • Loading branch information
dsonyy committed Nov 2, 2024
1 parent ff38f77 commit 87571ca
Showing 1 changed file with 29 additions and 9 deletions.
38 changes: 29 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,28 +8,48 @@ Follow these steps to build and serve the site locally:

1. **Install Ruby, Bundler, and Jekyll**
Make sure Ruby is installed on your system. Then, install Bundler and Jekyll:

```bash
sudo gem install bundler jekyll
```

2. **Install Dependencies**
Ensure you have Ruby, Bundler, and Jekyll installed. Then, install the required gems:

```bash
bundle install
```

3. **Build the Site**
Generate the static files in the `_site` directory:
```bash
bundle exec jekyll build
```
Generate the static files in the `_site` directory:

```bash
bundle exec jekyll build
```

4. **Serve the Site**
Serve the site locally at `http://localhost:4000`:
```bash
bundle exec jekyll serve
```
Serve the site locally at `http://localhost:4000`:
```bash
bundle exec jekyll serve
```

## Contributing

### Adding a rover

To add a new rover article to the website:

1. Go to the `_rovers` directory in the repository.
2. Copy the `_template.md` file. This template file provides the structure needed for each new article.
3. Rename the file to the unique name of your rover.
4. Fill in the content as instructed in the template, including any relevant metadata (like title, description, etc.).
5. Add any images related to your article in the `/assets/img/name-of-your-rover/...` directory. Make sure to use descriptive names to keep the images organized.
6. Afterward, please submit a pull request for review.

## Other Changes

If you have any other ideas, improvements, or fixes, feel free to make those changes and submit them in a pull request. Contributions of all kinds are welcome and highly appreciated!

## Development
## Development

- Based on modified [LightSpeed](https://github.com/tajacks/lightspeed) Jekyll theme under GPLv3.

0 comments on commit 87571ca

Please sign in to comment.