Skip to content

Commit

Permalink
🔧 tweaking README and workflows
Browse files Browse the repository at this point in the history
  • Loading branch information
chrede88 committed Nov 12, 2024
1 parent 131b723 commit 2b34a54
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 14 deletions.
6 changes: 2 additions & 4 deletions .github/template-cleanup/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,8 @@ Please follow the instructions below to finish the setup of your new L1nkr site.
```shell
git clone https://github.com/%USER%/%NAME%
```
2) Modify `config/_default/hugo.yaml` and `config/_default/params.yaml` according to the configuration below.
3) Build a local version of your site by executing `hugo server`. You can see the site by navigating to `http://localhost:1313/%NAME%/` (actual URL will be outputted in the CLI) in a browser.
4) Add a new image to the `assets/` folder, using the same name as you specified in `params.yaml`.
5) Add a new `icon.png` file to update the favicon. The png file should be 512px by 512px in size.
3) Modify `config/_default/hugo.yaml` and `config/_default/params.yaml` according to your needs. Find more info on the theme [wiki](https://github.com/chrede88/L1nkr/wiki/Configuration).
4) Build a local version of your site by executing `hugo server` at the root of the repository. You can see the site by navigating to `http://localhost:1313/%NAME%/` (actual URL will be outputted in the CLI) in a browser.

---

Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/buildDeploy.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ jobs:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }} # https://<username>.github.io/<repo>
runs-on: ubuntu-latest # runner
runs-on: ubuntu-24.04 # runner
needs: build # only do this if the build was succesfull
steps:
- name: Deploy to GitHub Pages
Expand Down
1 change: 0 additions & 1 deletion .github/workflows/cleanTemplate.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ concurrency:
group: first-time-setup
cancel-in-progress: false

# ADDED THIS CHANGE
permissions:
actions: write
checks: write
Expand Down
13 changes: 5 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,17 +6,14 @@ If you're looking for the actual theme repository, follow this [link](https://gi
## Installation

1) Use this template by pressing `Use this template`. **Don't fork this repository!**
2) Wait 20s-30s and update the page. The files in your repo are getting populated.
3) Add a LICENSE to your repo.
2) Wait 20s-30s and update the page. The `Clean Template` workflow will run automatically, creating/poplutating files based on your Github user.
3) Add a LICENSE to your repository.
4) Clone your version of the template to your local computer:
```shell
git clone https://github.com/<username>/<reponame>
```
5) Change the module name to match your github repo in `go.mod`.
6) Modify `config/_default/hugo.yaml` and `config/_default/params.yaml` according to the configuration below.
7) All images are stored in the `assets/` folder. You can group in subfolders if you like.
8) Build a local version of your site by executing `hugo server`. You can see the site by navigating to `localhost:1313` (actual URL will be outputted in the CLI) in a browser.
9) Add a new `icon.png` file to update the favicon. The png file should be 512px by 512px in size.
5) Modify `config/_default/hugo.yaml` and `config/_default/params.yaml` according to your needs. Find more info on the theme [wiki](https://github.com/chrede88/L1nkr/wiki/Configuration).
6) Build a local version of your site by executing `hugo server`, at the root of the repository. You can see the site by navigating to `localhost:1313` (actual URL will be outputted in the CLI) in a browser.

---

Expand All @@ -25,7 +22,7 @@ git clone https://github.com/<username>/<reponame>
- Simple LinkTree theme, designed for mobile-first.
- Automatically dark mode (based on system setttings).
- Emoji support for a fun design.
- More than 40 supported brand links.
- More than 50 supported brand links.
- Healthcheck endpoint (/healthcheck.json).

---
Expand Down

0 comments on commit 2b34a54

Please sign in to comment.