Skip to content

Commit

Permalink
replace readme shell with content
Browse files Browse the repository at this point in the history
  • Loading branch information
tlnagy committed Jul 19, 2017
1 parent 6f653e5 commit 353fd44
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 30 deletions.
41 changes: 11 additions & 30 deletions README.md
@@ -1,48 +1,29 @@
# jekyll-lab-notebook

Welcome to your new Jekyll theme! In this directory, you'll find the files you need to be able to package up your theme into a gem. Put your layouts in `_layouts`, your includes in `_includes` and your sass in `_sass`. To experiment with this code, add some sample content and run `bundle exec jekyll serve` – this directory is setup just like a Jekyll site!
[![Gem Version](https://badge.fury.io/rb/jekyll-lab-notebook.svg)](https://badge.fury.io/rb/jekyll-lab-notebook)

TODO: Delete this and the text above, and describe your gem
Supercharge your electronic lab notebook!

## Installation
This is a full-featured jekyll theme that lets you quickly write markdown
notebook entries and will create a great HTML website that you can run locally
to view all your hard work. It's hackable to its core so you can tweak it to
your heart's desire. Add pages, change layouts, add cool jekyll plugins,
whatever; think of this as your springboard.

Add this line to your Jekyll site's `Gemfile`:
![](screenshot.png)

```ruby
gem "jekyll-lab-notebook"
```
## Installation and Usage

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

```yaml
theme: jekyll-lab-notebook
```

And then execute:

$ bundle

Or install it yourself as:

$ gem install jekyll-lab-notebook

## Usage

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

## 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`, and `_sass` tracked with Git will be released.
TODO

## License

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

Binary file added screenshot.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 353fd44

Please sign in to comment.