Skip to content

Commit

Permalink
Update INSTALL.md (alshedivat#2237)
Browse files Browse the repository at this point in the history
Added "Recommended Approach" as a subheading which was not under
Installing , but was in the contents section.
  • Loading branch information
SasikaA073 committed Feb 29, 2024
1 parent ededd81 commit 50b503b
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions INSTALL.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@

# Installing and Deploying

## Recommended Approach

The recommended approach for using **al-folio** is to first create your own site using the template with as few changes as possible, and only when it is up and running customize it however you like. This way it is easier to pinpoint what causes a potential issue in case of a bug. The minimum steps required to create your own site are:

1. Create a new repository using this template. For this, click on [Use this template -> Create a new repository](https://github.com/new?template_name=al-folio&template_owner=alshedivat) above the file list. If you plan to upload your site to `<your-github-username>.github.io`, note that the name of your repository :warning: **MUST BE** :warning: `<your-github-username>.github.io` or `<your-github-orgname>.github.io`, as stated in the [GitHub pages docs](https://docs.github.com/en/pages/getting-started-with-github-pages/about-github-pages#types-of-github-pages-sites).
Expand Down

0 comments on commit 50b503b

Please sign in to comment.