Skip to content

Commit e1736bb

Browse files
KS1019alshedivat
andauthored
Update README.md to encourage people to use Use this template (#1167)
This PR changes README.md to encourage people to use `Use this template` rather than `fork`. ### Differences between `Use this template` and fork > - A new fork includes the entire commit history of the parent repository, while a repository created from a template starts with a single commit. > - Commits to a fork don't appear in your contributions graph, while commits to a repository created from a template do appear in your contribution graph. > - A fork can be a temporary way to contribute code to an existing project, while creating a repository from a template starts a new project quickly. [Ref](https://docs.github.com/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template) ### Cons Possible con would be that it is harder to pull the new changes from this repo to the users' repos. It does not seem like impossible to do so but it will require additonal actions on the users end. - https://github.com/orgs/community/discussions/23528 - https://stackoverflow.com/questions/56577184/github-pull-changes-from-a-template-repository --------- Co-authored-by: Maruan <[email protected]>
1 parent 182eb94 commit e1736bb

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

README.md

+6-5
Original file line numberDiff line numberDiff line change
@@ -212,7 +212,7 @@ $ docker-compose -f docker-local.yml up
212212

213213
#### Local Setup (Standard)
214214

215-
Assuming you have [Ruby](https://www.ruby-lang.org/en/downloads/) and [Bundler](https://bundler.io/) installed on your system (*hint: for ease of managing ruby gems, consider using [rbenv](https://github.com/rbenv/rbenv)*), first [fork](https://guides.github.com/activities/forking/) the theme from `github.com:alshedivat/al-folio` to `github.com:<your-username>/<your-repo-name>` and do the following:
215+
Assuming you have [Ruby](https://www.ruby-lang.org/en/downloads/) and [Bundler](https://bundler.io/) installed on your system (*hint: for ease of managing ruby gems, consider using [rbenv](https://github.com/rbenv/rbenv)*), first click [Use this template](https://docs.github.com/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template) above the file list, create a new repository at `github.com:<your-username>/<your-repo-name>` from `github.com:alshedivat/al-folio` and do the following:
216216

217217
```bash
218218
$ git clone [email protected]:<your-username>/<your-repo-name>.git
@@ -246,9 +246,10 @@ Starting version [v0.3.5](https://github.com/alshedivat/al-folio/releases/tag/v0
246246

247247
**To enable automatic deployment:**
248248
1. Click on **Actions** tab and **Enable GitHub Actions**; do not worry about creating any workflows as everything has already been set for you.
249-
2. Make any other changes to your webpage, commit, and push. This will automatically trigger the **Deploy** action.
250-
3. Wait for a few minutes and let the action complete. You can see the progress in the **Actions** tab. If completed successfully, in addition to the `master` branch, your repository should now have a newly built `gh-pages` branch.
251-
4. Finally, in the **Settings** of your repository, in the Pages section, set the branch to `gh-pages` (**NOT** to `master`). For more details, see [Configuring a publishing source for your GitHub Pages site](https://docs.github.com/en/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site#choosing-a-publishing-source).
249+
2. Go to Settings -> Actions -> General -> Workflow permissions, and give **Read and write permissions** to GitHub Actions
250+
3. Make any other changes to your webpage, commit, and push. This will automatically trigger the **Deploy** action.
251+
4. Wait for a few minutes and let the action complete. You can see the progress in the **Actions** tab. If completed successfully, in addition to the `master` branch, your repository should now have a newly built `gh-pages` branch.
252+
5. Finally, in the **Settings** of your repository, in the Pages section, set the branch to `gh-pages` (**NOT** to `master`). For more details, see [Configuring a publishing source for your GitHub Pages site](https://docs.github.com/en/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site#choosing-a-publishing-source).
252253

253254

254255
<details><summary>(click to expand) <strong>Manual deployment to GitHub Pages:</strong></summary>
@@ -332,7 +333,7 @@ If rebasing is too complicated, we recommend to re-install the new version of th
332333
Here are some frequently asked questions.
333334
If you have a different question, please ask using [Discussions](https://github.com/alshedivat/al-folio/discussions/categories/q-a).
334335

335-
1. **Q:** After I fork and setup the repo, I get a deployment error.
336+
1. **Q:** After I create a new repository from this template and setup the repo, I get a deployment error.
336337
Isn't the website supposed to correctly deploy automatically? <br>
337338
**A:** Yes, if you are using release `v0.3.5` or later, the website will automatically and correctly re-deploy right after your first commit.
338339
Please make some changes (e.g., change your website info in `_config.yml`), commit, and push.

0 commit comments

Comments
 (0)