From 9637e97f1cfb0abcb243215c01bc745e4fc6c5ca Mon Sep 17 00:00:00 2001 From: Sergey Nazaryev Date: Mon, 20 Jul 2020 01:42:09 +0300 Subject: Update to the latest version --- README.md | 63 ++++++++++++++++++++++++++++++++++++++++++++++++++++++--------- 1 file changed, 54 insertions(+), 9 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 5b2a406..d57ecf9 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,59 @@ -zar's homepage -============== +# nazaryev-blog -Site based on Jekyll with my blog and portfolio +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! -## Building +TODO: Delete this and the text above, and describe your gem -For building just type in shell: +## Installation -```bash -$ jekyll build -``` +Add this line to your Jekyll site's Gemfile: + +```ruby gem "nazaryev-blog" ``` + +And add this line to your Jekyll site's `_config.yml`: + +```yaml theme: nazaryev-blog ``` + +And then execute: + + $ bundle + +Or install it yourself as: + + $ gem install nazaryev-blog + +## Usage + +TODO: Write usage instructions here. Describe your available layouts, includes, +and/or sass. + +## 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`. + +You theme is setup just like a normal Jelyll 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. + +## License + +The theme is available as open source under the terms of the [MIT +License](http://opensource.org/licenses/MIT). -Static HTML pages will be generated in `_site` directory. -- cgit v1.1