Update readme and 1st post git instructions
This commit is contained in:
parent
8769bf3f19
commit
88112754e0
11
README.md
11
README.md
@ -14,7 +14,7 @@ The theme works well on mobile phones, using a collapsable nav bar and hiding th
|
|||||||
sidebar. The links pane in the sidebar is available on mobile through the nav menu,
|
sidebar. The links pane in the sidebar is available on mobile through the nav menu,
|
||||||
and you can do the same thing for any other sections added to the sidebar.
|
and you can do the same thing for any other sections added to the sidebar.
|
||||||
|
|
||||||
Don't forget to occassionally rebase against my upstream repository so you can get
|
Don't forget to occassionally merge against my upstream repository so you can get
|
||||||
the latest changes. Pull requests are encouraged and accepted!
|
the latest changes. Pull requests are encouraged and accepted!
|
||||||
|
|
||||||
Installation
|
Installation
|
||||||
@ -24,7 +24,7 @@ If you don't have a blog already on github, start by cloning this repository.
|
|||||||
Best to do that directly on github and then clone that down to your computer.
|
Best to do that directly on github and then clone that down to your computer.
|
||||||
|
|
||||||
If you already do have a blog, You can certainly apply this theme to your existing
|
If you already do have a blog, You can certainly apply this theme to your existing
|
||||||
blog in place, but then you won't be able to rebase as the theme changes. If you
|
blog in place, but then you won't be able to merge as the theme changes. If you
|
||||||
re-apply your blog history on top of this theme's **gh-pages** branch, it's then
|
re-apply your blog history on top of this theme's **gh-pages** branch, it's then
|
||||||
easy to update to the latest version of the theme. You also don't want to have to
|
easy to update to the latest version of the theme. You also don't want to have to
|
||||||
deal with resolving old conflicts from your existing history, so you may wish to to
|
deal with resolving old conflicts from your existing history, so you may wish to to
|
||||||
@ -42,17 +42,16 @@ You can setup an upstream tracking repository like so:
|
|||||||
$ git remote add upstream git@github.com:scotte/jekyll-clean.git
|
$ git remote add upstream git@github.com:scotte/jekyll-clean.git
|
||||||
```
|
```
|
||||||
|
|
||||||
And now when you wish to rebase your own branch onto the latest version of the
|
And now when you wish to merge your own branch onto the latest version of the
|
||||||
theme, simply do:
|
theme, simply do:
|
||||||
|
|
||||||
```
|
```
|
||||||
$ git fetch upstream
|
$ git fetch upstream
|
||||||
$ git rebase upstream/gh-pages
|
$ git merge upstream/gh-pages
|
||||||
```
|
```
|
||||||
|
|
||||||
Of course you will have to resolve conflicts for \_config.yml, \_includes/links-list.html,
|
Of course you will have to resolve conflicts for \_config.yml, \_includes/links-list.html,
|
||||||
and \_posts, and so on, but in practice this is pretty simple. And of course the great
|
and \_posts, and so on, but in practice this is pretty simple.
|
||||||
thing about doing it as a rebase is you are only merging your own conflicts.
|
|
||||||
|
|
||||||
This is how I maintain my own blog which is based on this theme. The old history is
|
This is how I maintain my own blog which is based on this theme. The old history is
|
||||||
sitting in an **old-master** branch that I can refer to when I need to.
|
sitting in an **old-master** branch that I can refer to when I need to.
|
||||||
|
@ -20,7 +20,7 @@ The theme works well on mobile phones, using a collapsable nav bar and hiding th
|
|||||||
sidebar. The links pane in the sidebar is available on mobile through the nav menu.
|
sidebar. The links pane in the sidebar is available on mobile through the nav menu.
|
||||||
and you can do the same thing for any other sections added to the sidebar.
|
and you can do the same thing for any other sections added to the sidebar.
|
||||||
|
|
||||||
Don't forget to occassionally rebase against my upstream repository so you can get
|
Don't forget to occassionally merge against my upstream repository so you can get
|
||||||
the latest changes. Pull requests are encouraged and accepted!
|
the latest changes. Pull requests are encouraged and accepted!
|
||||||
|
|
||||||
Installation
|
Installation
|
||||||
@ -30,7 +30,7 @@ If you don't have a blog already on github, start by cloning this repository.
|
|||||||
Best to do that directly on github and then clone that down to your computer.
|
Best to do that directly on github and then clone that down to your computer.
|
||||||
|
|
||||||
If you already do have a blog, You can certainly apply this theme to your existing
|
If you already do have a blog, You can certainly apply this theme to your existing
|
||||||
blog in place, but then you won't be able to rebase as the theme changes. If you
|
blog in place, but then you won't be able to merge as the theme changes. If you
|
||||||
re-apply your blog history on top of this theme's **gh-pages** branch, it's then
|
re-apply your blog history on top of this theme's **gh-pages** branch, it's then
|
||||||
easy to update to the latest version of the theme. You also don't want to have to
|
easy to update to the latest version of the theme. You also don't want to have to
|
||||||
deal with resolving old conflicts from your existing history, so you may wish to to
|
deal with resolving old conflicts from your existing history, so you may wish to to
|
||||||
@ -47,17 +47,16 @@ You can setup an upstream tracking repository like so:
|
|||||||
```
|
```
|
||||||
$ git remote add upstream git@github.com:scotte/jekyll-clean.git
|
$ git remote add upstream git@github.com:scotte/jekyll-clean.git
|
||||||
```
|
```
|
||||||
And now when you wish to rebase your own branch onto the latest version of the
|
And now when you wish to merge your own branch onto the latest version of the
|
||||||
theme, simply do:
|
theme, simply do:
|
||||||
|
|
||||||
```
|
```
|
||||||
$ git fetch upstream
|
$ git fetch upstream
|
||||||
$ git rebase upstream/gh-pages
|
$ git merge upstream/gh-pages
|
||||||
```
|
```
|
||||||
|
|
||||||
Of course you will have to resolve conflicts for \_config.yml, \_includes/links-list.html,
|
Of course you will have to resolve conflicts for \_config.yml, \_includes/links-list.html,
|
||||||
and \_posts, and so on, but in practice this is pretty simple. And of course the great
|
and \_posts, and so on, but in practice this is pretty simple.
|
||||||
thing about doing it as a rebase is you are only merging your own conflicts.
|
|
||||||
|
|
||||||
This is how I maintain my own blog which is based on this theme. The old history is
|
This is how I maintain my own blog which is based on this theme. The old history is
|
||||||
sitting in an **old-master** branch that I can refer to when I need to.
|
sitting in an **old-master** branch that I can refer to when I need to.
|
||||||
|
Reference in New Issue
Block a user