Skip to content

Commit 357c514

Browse files
committed
Tweak the README:
- Mostly preparing for publishing on Rubygems.org - Remove the mention about the 3.0 support since it has been dropped. There are too many issues on Windows to make it worth supporting it. That version is also super old
1 parent fc2d2b2 commit 357c514

File tree

1 file changed

+3
-13
lines changed

1 file changed

+3
-13
lines changed

README.md

Lines changed: 3 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
> [!NOTE]
2-
> **This tool is currently in active development.** The base functionalities work but we are working on adding more feature and polishing the overall experience.
2+
> **This tool is currently in active development.** We are very much looking for your feedback feedback.
33
44
## 🗒️ Preambule
55

@@ -25,20 +25,13 @@ As noted by @flavorjoes, this toolchain works great but it's complex and brittle
2525
> [!NOTE]
2626
> cibuildgem is for now not able to compile projects that needs to link on external libraries. Unless the project vendors those libraries or uses [mini_portile](https://github.com/flavorjones/mini_portile).
2727
28-
> [!IMPORTANT]
29-
> Repositories hosted on GitHub organization that don't belong to Shopify can't be tested at the moment. This is a temporary limitation that will be lifted
30-
> once we opensource this tool and publish its associated GitHub action.
31-
>
32-
> You can either fork the repo inside the shopify-playground org or you can ping me (@edouard-chin) and I'll help you set it up.
33-
34-
3528
### How to use it
3629

3730
While cibuildgem is generally **not** meant to be used locally, it provides a command to generate the right GitHub workflow for your project:
3831

39-
1. Install cibuildgem: `git clone https://github.com/shopify-playground/edouard-playground`, `cd edouard-playground && rake install`
32+
1. Install cibuildgem: `gem install cibuildgem`
4033
2. Generate the workflow: `cd` in your gem's folder and run `cibuildgem ci_template`
41-
3. Commit the `.github/gem-compile.yaml` file.
34+
3. Commit the `.github/workflows/cibuildgem.yaml` file.
4235

4336
### Triggering the workflow
4437

@@ -75,7 +68,6 @@ end
7568

7669
| | MacOS Intel | MacOS ARM | Windows x64 UCRT | Linux GNU x86_64|Linux AARCH64 |
7770
|---------|------------- | --------- | ------------|-----------------|-----------------|
78-
| Ruby 3.0| 🟢 | 🟢 | 🟢 | 🟢 | 🟢 |
7971
| Ruby 3.1| 🟢 | 🟢 | 🟢 | 🟢 | 🟢 |
8072
| Ruby 3.2| 🟢 | 🟢 | 🟢 | 🟢 | 🟢 |
8173
| Ruby 3.3| 🟢 | 🟢 | 🟢 | 🟢 | 🟢 |
@@ -84,5 +76,3 @@ end
8476
## 🧪 Development
8577

8678
If you'd like to run a end-to-end test, the `date` gem is vendored in this project. You can trigger a manual run to do the whole compile, test, install dance from the GitHub action menu.
87-
88-
<img width="1350" height="225" alt="Image" src="https://github.com/user-attachments/assets/e34946d8-aff2-4aac-92c0-108f1d5beda0" />

0 commit comments

Comments
 (0)