Skip to content
This repository was archived by the owner on Sep 11, 2021. It is now read-only.

Commit f8fa897

Browse files
committed
Update Readme
1 parent d79de2b commit f8fa897

File tree

1 file changed

+20
-38
lines changed

1 file changed

+20
-38
lines changed

README.md

Lines changed: 20 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1,45 +1,27 @@
1-
# Jekyll-Bootstrap
1+
# Jekyll-Bootstrap-3
22

3-
The quickest way to start and publish your Jekyll powered blog. 100% compatible with GitHub pages
3+
Easily publish Bootstrap 3 powered Jekyll sites.
4+
Fork of the well known jekyll-bootstrap (v0.3.0). Original project is [here](https://github.com/plusjade/jekyll-bootstrap).
5+
The quickest way to start and publish your Jekyll powered blog. 100% compatible with GitHub pages.
46

57
## Usage
68

7-
For all usage and documentation please see: <http://jekyllbootstrap.com>
8-
9-
## Version
10-
11-
0.3.0 - stable and versioned using [semantic versioning](http://semver.org/).
12-
13-
**NOTE:** 0.3.0 introduces a new theme which is not backwards compatible in the sense it won't _look_ like the old version.
14-
However, the actual API has not changed at all.
15-
You might want to run 0.3.0 in a branch to make sure you are ok with the theme design changes.
16-
17-
## Contributing
18-
19-
This repository tracks 2 projects:
20-
21-
- **Jekyll-Bootstrap Framework.**
22-
The framework for which users should clone and build their blog on top of is available in the master branch.
23-
24-
To contribute to the framework please make sure to checkout your branch based on `jb-development`!!
25-
This is very important as it allows me to accept your pull request without having to publish a public version release.
26-
27-
Small, atomic Features, bugs, etc.
28-
Use the `jb-development` branch but note it will likely change fast as pull requests are accepted.
29-
Please rebase as often as possible when working.
30-
Work on small, atomic features/bugs to avoid upstream commits affecting/breaking your development work.
31-
32-
For Big Features or major API extensions/edits:
33-
This is the one case where I'll accept pull-requests based off the master branch.
34-
This allows you to work in isolation but it means I'll have to manually merge your work into the next public release.
35-
Translation : it might take a bit longer so please be patient! (but sincerely thank you).
36-
37-
- **Jekyll-Bootstrap Documentation Website.**
38-
The documentation website at <http://jekyllbootstrap.com> is maintained in the gh-pages branch.
39-
Please fork and contribute documentation additions to this branch only.
40-
41-
The master and gh-pages branch do not share the same ancestry. Please treat them as completely separate git repositories!
42-
9+
### 1. Create a Repo
10+
- Go to <https://github.com> and create a new repository named *USERNAME.github.com*
11+
12+
### 2. Install Jekyll-Bootstrap-3
13+
<pre>
14+
<code>
15+
$ git clone https://github.com/dbtek/jekyll-bootstrap-3 USERNAME.github.com
16+
$ cd USERNAME.github.com
17+
$ git remote set-url origin [email protected]:USERNAME/USERNAME.github.com.git
18+
$ git push origin master
19+
</code>
20+
</pre>
21+
### 3. Enjoy !
22+
- After giving 10 mins to GitHub of course.
23+
24+
For original project's usage and documentation please see: <http://jekyllbootstrap.com>
4325

4426
## License
4527

0 commit comments

Comments
 (0)