Skip to content

Commit a3989d2

Browse files
authored
Merge pull request #66 from getsolus/update-readme
Update the README, migrate the last useful command from the Makefile to the taskfile, and nuke the Makefile
2 parents de40069 + fdcd21b commit a3989d2

File tree

3 files changed

+32
-19
lines changed

3 files changed

+32
-19
lines changed

Makefile

Lines changed: 0 additions & 11 deletions
This file was deleted.

README.md

Lines changed: 28 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,11 @@
22

33
Static, [Hugo-based](https://gohugo.io) home of Solus and its projects. This website makes use of:
44

5-
1. A custom theme, [`solus-hugo-theme`](https://github.com/getsolus/solus-hugo-theme).
6-
2. Website content itself, including blog posts, in `content`.
5+
1. A custom theme, [`solus-hugo-theme`](themes/solus).
6+
2. Website content itself, including blog posts, in [`content`](content).
77

8-
**Note:** SASS styling is provided inside the Hugo themes and is built upon [`solbit`](https://github.com/getsolus/solbit).
8+
> [!Note]
9+
> SASS styling is provided inside the Hugo themes and is built upon [`solbit`](https://github.com/getsolus/solbit).
910
1011
## Creation
1112

@@ -75,19 +76,38 @@ For instance, Mailgun templates use the desktop collage graphic. Please coordina
7576

7677
### Setup
7778

78-
To set up your Solus system for developing the website, you first need to ensure you have the necessary dependencies installed. Run `make setup` to install the necessary dependencies as well as init git submodules.
79+
To set up your Solus system for developing the website, you first need to ensure you have the necessary dependencies installed. You'll need:
7980

80-
Next, run `make sync` to update the Hugo themes.
81+
- `hugo`
82+
- `sassc`
83+
- Optionally, install `go-task` to simplify running the website locally, or deploying it to production.
84+
85+
You can install these on Solus by running:
86+
87+
```bash
88+
sudo eopkg install hugo sassc go-task
89+
```
8190

8291
### Local Server
8392

84-
You can start up a local server by calling `make local` in the `solus-site` directory. This will expose the site on `http://127.0.0.1:1313`. Use this to see your changes and make sure things look as you expect before submitting a pull request.
93+
You can start up a local server by running the task:
94+
95+
```bash
96+
go-task local
97+
```
98+
99+
Use this to see your changes and make sure things look as you expect before submitting a pull request.
85100

86-
**Note:** You will not need to restart the server when doing changes. Hugo does file watching across all the things.
101+
> [!Note]
102+
> You will not need to restart the server when doing changes. Hugo does file watching across all the things.
87103
88104
### Deployment
89105

90-
Merge the `main` branch into `deploy` and push.
106+
Run the task to deploy the website via Github Pages.
107+
108+
```bash
109+
go-task deploy
110+
```
91111

92112
### Styling
93113

Taskfile.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,3 +20,7 @@ tasks:
2020
- git merge main
2121
- git push origin deploy
2222
- git switch main
23+
local:
24+
desc: Start a webserver to test the website locally
25+
cmds:
26+
- 'hugo server --watch --disableFastRender --ignoreCache'

0 commit comments

Comments
 (0)