Skip to content

Commit

Permalink
Add images and modify readme accordingly
Browse files Browse the repository at this point in the history
  • Loading branch information
ptone committed Aug 1, 2013
1 parent e19d4dd commit c614624
Show file tree
Hide file tree
Showing 5 changed files with 181 additions and 11 deletions.
51 changes: 40 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,21 +13,33 @@ To create a website for a new boot camp:
1. Create a [new repository on GitHub](https://github.com/new)
with a name like YYYY-MM-DD-site, e.g., `2014-03-31-ehu`.
This repository must *not* be a fork of an existing repository.
2. Clone this new repository to your desktop.
3. Add the template repository `[email protected]:swcarpentry/bc.git` as a remote called `upstream`.
2. Clone this new repository to your local machine and `cd` into it. You can
ignore the warning about cloning an empty repository, it won't stay empty
long.

git remote add upstream [email protected]:swcarpentry/bc.git
![Alt text](img/readme/step1.png)

4. Create a new branch in the desktop clone called `gh-pages`.
3. Add the template repository `[email protected]:swcarpentry/bc.git` as a remote named `swcarpentry`.

git remote add swcarpentry [email protected]:swcarpentry/bc.git

![Alt text](img/readme/step2.png)

4. Create a new branch in the local clone named `gh-pages`.

git checkout -b gh-pages

5. Pull content from the GitHub template repository using `git pull upstream gh-pages`.
5. Pull content from the GitHub template repository:

git pull swcarpentry gh-pages

6. Edit `index.html` to create the boot camp home page (see below).
Please double-check the information in the page's header (described below),
as it is used to update the main website.
7. Preview your changes (see below).
8. Push content to your YYYY-MM-DD-site repository using `git push origin gh-pages`.
8. Push content to your YYYY-MM-DD-site repository:

git push origin gh-pages

As soon as your repo has been pushed to GitHub, GitHub will render your pages
at the url:
Expand Down Expand Up @@ -146,14 +158,31 @@ The images that these files refer to have not yet been created.
Improving This Material
-----------------------

We welcome improvements to the master copy of the boot camp template repository,
particularly new lesson material.
We welcome improvements to the master copy of the boot camp template
repository, particularly new lesson material. It will be easiest if you make
improvements you intend to share in their own commits, separate from commits
specific to your bootcamp.

To send them to us:

1. Fork the `bc` repository on GitHub.
2. Make that a remote of your desktop copy of your YYYY-MM-DD-site repository.
3. Push your changes from your desktop to your fork of `bc` on GitHub.
4. Send a pull request (PR) to the master repository.
2. Make that a remote named "upstream" of your local YYYY-MM-DD-site repository.

git remote add upstream [email protected]:<me>/bc.git

(replace 'me' with your GitHub username)

![Alt text](img/readme/step3.png)

3. Isolate the changes you want to share in a branch and push them
to GitHub.

git fetch swcarpentry
git checkout -t swcarpentry/gh-pages -b improvements
git cherry-pick <commits related to improvements on your gh-pages branch>
git push upstream improvements

4. Send a pull request (PR) to the master repository on GitHub.

FAQ
---
Expand Down
Binary file added img/readme/step1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added img/readme/step2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added img/readme/step3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
141 changes: 141 additions & 0 deletions img/readme/steps-src.svg
Loading
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 c614624

Please sign in to comment.