Skip to content

Commit f3b4019

Browse files
committed
Update readme
1 parent b7485c6 commit f3b4019

2 files changed

Lines changed: 17 additions & 3 deletions

File tree

.github/workflows/ci.yml

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,16 @@ jobs:
1313
steps:
1414
- uses: actions/checkout@v4
1515

16+
# The tests mock libcurl symbols (see tests/curl_mock.cpp), but the
17+
# production code under test still includes <curl/curl.h> for the type
18+
# definitions. ZLIB is needed by ZipExtractor. zlib1g-dev is usually
19+
# pre-installed on ubuntu-latest, but make it explicit so this doesn't
20+
# silently break on a future runner image.
21+
- name: Install build dependencies
22+
run: |
23+
sudo apt-get update
24+
sudo apt-get install -y libcurl4-openssl-dev zlib1g-dev
25+
1626
- name: Configure
1727
run: |
1828
mkdir -p tests/build

README.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -40,9 +40,9 @@
4040
- Per-game mod list with icons, screenshots, tags, and metadata
4141
- Tag filtering and sort cycling (Default / Name / Version) on the Browse tab
4242
- Concurrent download queue with per-job progress, cancel, and error recovery
43-
- Resumable downloads — interrupted transfers pick up where they left off
43+
- Resumable downloads. Interrupted transfers pick up where they left off.
4444
- Optional SHA-256 verification of downloaded archives
45-
- Atomic install — failed extracts never leave a half-installed mod behind
45+
- Atomic install. Failed extracts never leave a half-installed mod behind.
4646
- Activate / deactivate mods without uninstalling
4747
- Conflict detection between active mods (with file-level diff in the dialog)
4848
- Update badges and one-press "update all" for installed mods
@@ -72,8 +72,12 @@ I've also created a [video tutorial on YouTube](https://youtu.be/FF4uRc8NvnI)
7272
7373
## Hosting your own repo
7474

75-
CoffeeShop loads mods from community-hosted repositories. To host your own:
75+
CoffeeShop loads mods from community-hosted repositories. Two ways to set one up:
7676

77+
**Easy path (no JSON editing, no command line):**
78+
Use the [CoffeeShop Repo Builder](https://tim.kicker.dev/coffeeshop-builder/). Click together your repo in the browser, drop ZIPs to compute their SHA-256 automatically, then download a ready-to-publish ZIP. The builder also lets you import an existing `repo.json` URL and edit it.
79+
80+
**Manual path:**
7781
1. Fork [coffeeshop-repo-template](https://github.com/timkicker/coffeeshop-repo-template)
7882
2. Add your games and mods following the schema in the template README
7983
3. Point your `config.json` at your fork's raw `repo.json` URL

0 commit comments

Comments
 (0)