Based off https://projectpages.github.io.
If you have bundler installed:
sudo bundle install
otherwise sudo gem install bundler
first.
To compile and run,
bundler exec jekyll serve &
will give you a local webserver.
The workflow is a typical git
workflow. You will need to install git.
-
Fork the repository to your own repositories by clicking the
Fork
button on the upper-right in Github -
Clone the repository to your machine:
git clone https://github.com/yourusername/website.git
-
Make the
c-proof
version of the webpage aremote
calledupstream
git remote add upstream https://github.com/c-proof/website.git
We do this so we can sync with other people's changes as they are merged on the original. -
Checkout a new branch:
git checkout -b new-branch-name
-
Edit something; If you add new files remember to do
git add newfilepath/newfilename
. -
Commit changes:
git commit -a -m "EDIT: helpful message about your change"
-
Push the changes to your remote:
git push origin new-branch-name
7 git will now suggest that you can make a pull request to c-proof
. Do so and then it will get merged if all is OK