commit 24e6e2ff3b2ccd0164fd84bdcf7b54f7828f15fd
parent 4348dc62ac46f17c376e56f3f968303c931cd324
Author: Nathan Randecker <nathan.randecker@gmail.com>
Date: Mon, 16 Jan 2017 23:19:19 -0600
Added readme
Diffstat:
| M | README.md | | | 76 | ++++++++++++++++++++++++++++++++++++++++++++++------------------------------ |
| M | package.json | | | 4 | ++-- |
2 files changed, 48 insertions(+), 32 deletions(-)
diff --git a/README.md b/README.md
@@ -1,48 +1,64 @@
-# particle
+# Particle Jekyll Theme
-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!
+This is a simple and minimalist template for Jekyll designed for developers that want to show of their portfolio.
-TODO: Delete this and the text above, and describe your gem
+The Theme features:
-## Installation
+- Gulp
+- SASS
+- Sweet Scroll
+- Font Awesome and Devicon icons
+- Very very small and fast!
+- Sitemap.xml
+- Info Customization
-Add this line to your Jekyll site's Gemfile:
+## Basic Setup
-```ruby
-gem "particle"
-```
-
-And add this line to your Jekyll site's `_config.yml`:
-
-```yaml
-theme: particle
-```
-
-And then execute:
+1. [Install Jekyll](http://jekyllrb.com)
+2. Fork the [Particle Template](https://github.com/nrandecker/particle/fork)
+3. Clone the repo you just forked.
+4. Edit `_config.yml` to personalize your site.
- $ bundle
+## Site and User Settings
-Or install it yourself as:
+You have to fill some informations on `_config.yml` to customize your site.
- $ gem install particle
-
-## Usage
-
-TODO: Write usage instructions here. Describe your available layouts, includes, and/or sass.
+```
+# Site settings
+description: A blog about lorem ipsum dolor sit amet
+baseurl: "" # the subpath of your site, e.g. /blog/
+url: "http://localhost:3000" # the base hostname & protocol for your site
+
+# User settings
+username: Lorem Ipsum
+user_description: Anon Developer at Lorem Ipsum Dolor
+user_title: Anon Developer
+email: anon@anon.com
+twitter_username: lorem_ipsum
+github_username: lorem_ipsum
+gplus_username: lorem_ipsum
+```
-## Contributing
+**Don't forget to change your baseurl before build your site!**
-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.
+## Running the blog in local
-## Development
+In order to compile the assets and run Jekyll on local you need to follow those steps:
-To set up your environment to develop this theme, run `bundle install`.
+- Install [NodeJS](https://nodejs.org/)
+- Run `npm install`
+- Run `gulp`
-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.
+## Questions
-When your theme is released, only the files in `_layouts`, `_includes`, and `_sass` tracked with Git will be released.
+Having any issues file a [GitHub Issue](https://github.com/nrandecker/particle/issues/new).
## License
-The theme is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+This theme is free and open source software, distributed under the The MIT License. So feel free to use this Jekyll theme on your site without linking back to me or using a disclaimer.
+
+## Credits
+This theme was partially designed with the inspiration from these fine folks
+- [Willian Justen](https://github.com/willianjusten/will-jekyll-template)
+- [Vincent Garreau](https://github.com/VincentGarreau/particles.js/)
diff --git a/package.json b/package.json
@@ -1,12 +1,12 @@
{
"name": "particle",
"version": "1.0.0",
- "description": "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!",
+ "description": "",
"main": "index.js",
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
},
- "author": "",
+ "author": "Nathan Randecker",
"license": "ISC",
"dependencies": {
"gulp": "^3.9.1",
