diff --git a/INSTALL.md b/INSTALL.md index 567e0f9db226..80690b7f54f8 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -25,7 +25,7 @@ The recommended approach for using **al-folio** is to first create your own site 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 `.github.io`, note that the name of your repository :warning: **MUST BE** :warning: `.github.io` or `.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). 2. In this new repository, go to `Settings -> Actions -> General -> Workflow permissions` and give `Read and write permissions` to GitHub Actions. -3. Open file `_config.yml`, set `url` to `https://.github.io` and leave `baseurl` **empty** (do NOT delete it), like `baseurl:`. +3. Open file `_config.yml`, set `url` to `https://.github.io` and leave `baseurl` **empty** (do NOT delete it), as `baseurl:`. 4. Wait until the GitHub action with subtitle `Deploy site` finishes (check your repository **Actions** tab). Now, in addition to the `master` branch, your repository has a newly built `gh-pages` branch. 5. Finally, in the repository page go to `Settings -> Pages -> Build and deployment`, make sure that `Source` is set to `Deploy from a branch` and set the branch to `gh-pages` (NOT to master). 6. Wait until the GitHub action `pages-build-deployment` finishes (check your repository **Actions** tab), then simply navigate to `https://.github.io` in your browser. At this point you should see a copy of the theme's [demo website](https://alshedivat.github.io/al-folio/).