Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
dannypagano committed Apr 15, 2024
1 parent 79a6599 commit cdbf2cd
Showing 1 changed file with 2 additions and 48 deletions.
50 changes: 2 additions & 48 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,48 +1,2 @@
# brownfox

A minimal portfolio theme for Jekll.


## Installation

Add this line to your Jekyll site's `Gemfile`:

```ruby
gem "brownfox"
```

And add this line to your Jekyll site's `_config.yml`:

```yaml
theme: brownfox
```

And then execute:

$ bundle

Or install it yourself as:

$ gem install brownfox

## Usage

TODO: Write usage instructions here. Describe your available layouts, includes, sass and/or assets.

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/hello. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

## Development

To set up your environment to develop this theme, run `bundle install`.

Your theme is setup just like a normal Jekyll site! To test your theme, run `bundle exec jekyll serve` and open your browser at `http://localhost:4000`. This starts a Jekyll server using your theme. Add pages, documents, data, etc. like normal to test your theme's contents. As you make modifications to your theme and to your content, your site will regenerate and you should see the changes in the browser after a refresh, just like normal.

When your theme is released, only the files in `_layouts`, `_includes`, `_sass` and `assets` tracked with Git will be bundled.
To add a custom directory to your theme-gem, please edit the regexp in `brownfox.gemspec` accordingly.

## License

The theme is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

# README
A custom designed portfolio site built with Jekyll and hosted on GitHub Pages.

0 comments on commit cdbf2cd

Please sign in to comment.