Skip to content

Commit

Permalink
Add notes on running jekyl
Browse files Browse the repository at this point in the history
  • Loading branch information
makeasnek committed Oct 30, 2023
1 parent cedf65c commit 5fc06bb
Showing 1 changed file with 13 additions and 8 deletions.
21 changes: 13 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,15 +18,18 @@ For installation of Jekyll, please follow the [installation guide](https://jekyl

3. `git clone https://github.com/gridcoin-community/Gridcoin-Site.git`
(replace this with your fork)

4. `cd Gridcoin-Site`

5. `git branch your_branch_name` (give it a descriptive name like "whitelist changes") followed by `git checkout your_branch_name`
5. Run`bundle install` (preps the web server for local previewing)

6. `git branch your_branch_name` (give it a descriptive name like "whitelist changes") followed by `git checkout your_branch_name`7

6. Every time you make changes, run `git commit -a` to add your changes followed by `git push` to push them to your repo on github.com. The first time you push, you'll need to run `git push --set-upstream origin your_branch_name` first to let Github.com know about your new branch.
7. Every time you make changes, run `git commit -a` to add your changes followed by `git push` to push them to your repo on github.com. The first time you push, you'll need to run `git push --set-upstream origin your_branch_name` first to let Github.com know about your new branch.

7. `bundle install` (runs the web server for local previewing)
8. You can preview your changes with a local development server by running `bundle exec jekyll serve`

8. When ready to submit changes, go back to your fork on github.com and you will be prompted to make a pull request.
9. When ready to submit changes, go back to your fork on github.com and you will be prompted to make a pull request.

### Windows guide

Expand All @@ -38,13 +41,15 @@ For installation of Jekyll, please follow the [installation guide](https://jekyl

4. Go to Gridcoin-Site folder (or whatever you specified when pulling the repo) `Shift+RightClick` -> Open Cmd Prompt Here or Open Powershell window here(Win 10)

5. `git branch your_branch_name` (give it a descriptive name like "whitelist changes") followed by `git checkout your_branch_name`
5. Run `bundle install` (preps the web server for local previewing)

6. `git branch your_branch_name` (give it a descriptive name like "whitelist changes") followed by `git checkout your_branch_name`

6. Every time you make changes, run `git commit -a` to add your changes followed by `git push` to push them to your repo on github.com. The first time you push, you'll need to run `git push --set-upstream origin your_branch_name` first to let Github.com know about your new branch.
7. Every time you make changes, run `git commit -a` to add your changes followed by `git push` to push them to your repo on github.com. The first time you push, you'll need to run `git push --set-upstream origin your_branch_name` first to let Github.com know about your new branch.

7. Run `bundle install` (runs the web server for local previewing)
8. You can preview your changes with a local development server by running `bundle exec jekyll serve`

8. When ready to submit changes, go back to your fork on github.com and you will be prompted to make a pull request.
9. When ready to submit changes, go back to your fork on github.com and you will be prompted to make a pull request.

### Editing Specific Sections

Expand Down

0 comments on commit 5fc06bb

Please sign in to comment.