Skip to content

Commit 40fe260

Browse files
Improve README.md for new contributors
Fixes #62 Add detailed instructions and additional resources to the `README.md` file. * **Contributing**: Add a section with a brief overview and a link to the `CONTRIBUTING.md` file. * **Resources**: Add a section with links to relevant documentation, tutorials, and other resources. * **Setting Up GitHub Actions for Automated Builds**: Add a section with steps to set up GitHub Actions for automated builds.
1 parent 7e93ebf commit 40fe260

File tree

1 file changed

+39
-0
lines changed

1 file changed

+39
-0
lines changed

README.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -196,3 +196,42 @@ You can download the latest ISO from the [releases page](https://github.com/Gith
196196
## License
197197

198198
This project is licensed under my custom license - see the [LICENSE](LICENSE) file for details.
199+
200+
---
201+
202+
## Contributing
203+
204+
We welcome contributions! Please see the [CONTRIBUTING.md](CONTRIBUTING.md) file for guidelines on how to get involved.
205+
206+
---
207+
208+
## Resources
209+
210+
Here are some additional resources for new contributors:
211+
212+
- [Arch Linux Wiki](https://wiki.archlinux.org/)
213+
- [Arch Linux Forums](https://bbs.archlinux.org/)
214+
- [Arch Linux Documentation](https://archlinux.org/documentation/)
215+
- [GitHub Actions Documentation](https://docs.github.com/en/actions)
216+
- [Docker Documentation](https://docs.docker.com/)
217+
218+
---
219+
220+
## Setting Up GitHub Actions for Automated Builds
221+
222+
To set up GitHub Actions for automated builds, follow these steps:
223+
224+
1. **Create a GitHub Actions Workflow**:
225+
- Create a `.github/workflows/build.yaml` file with the necessary configuration to build and release the ISO.
226+
227+
2. **Configure the Workflow**:
228+
- Ensure the workflow is set up to trigger on the desired events, such as pushes to the `main` branch or scheduled runs.
229+
230+
3. **Monitor Workflow Runs**:
231+
- Go to the **Actions** tab in your repository to see the status of workflow runs and view detailed logs.
232+
233+
4. **Troubleshoot Failures**:
234+
- Check the logs for error messages and rerun failed jobs if necessary.
235+
236+
5. **Update Dependencies**:
237+
- Use Dependabot to automate dependency updates for GitHub Actions workflows.

0 commit comments

Comments
 (0)