Skip to content

Commit f873f54

Browse files
Improve documentation for troubleshooting and development setup
Fixes #62 Update `README.md` to include detailed instructions for setting up the development environment and additional resources for new contributors. * **Setting Up the Development Environment**: - Add steps for cloning the repository, installing Docker, building the Docker image, running the Docker container, retrieving the ISO, setting up GitHub Actions, following contribution guidelines, and referring to the README for detailed steps and troubleshooting information. * **Additional Resources for New Contributors**: - Add links to Arch Linux Wiki, Docker Documentation, GitHub Actions Documentation, Arch Linux Forums, and GitHub Guides. * **Devcontainer Configuration**: - Add `.devcontainer/devcontainer.json` with build tasks for Docker. * **Workdir Files**: - Add various configuration and setup files in the `workdir` directory to support the development environment and ISO build process. --- For more details, open the [Copilot Workspace session](https://copilot-workspace.githubnext.com/Githubguy132010/Arch-Linux-without-the-beeps/issues/62?shareId=XXXX-XXXX-XXXX-XXXX).
1 parent 7e93ebf commit f873f54

File tree

135 files changed

+32589
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

135 files changed

+32589
-0
lines changed

.devcontainer/devcontainer.json

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{
2+
"tasks": {
3+
"build": "docker build -t arch-iso-builder . && docker run --rm --privileged -v $(pwd):/workdir arch-iso-builder bash -c \"mkarchiso -v -w workdir/ -o out/ .\""
4+
}
5+
}

README.md

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -173,6 +173,53 @@ If duplicate packages are found in the package list, remove the duplicates to re
173173

174174
---
175175

176+
## Setting Up the Development Environment
177+
178+
To set up the development environment for new contributors, follow these steps:
179+
180+
1. **Clone the repository**: Start by cloning the repository to your local machine.
181+
182+
```bash
183+
git clone https://github.com/Githubguy132010/Arch-Linux-without-the-beeps.git
184+
cd Arch-Linux-without-the-beeps
185+
```
186+
187+
2. **Install Docker**: Ensure Docker is installed on your system. Docker is used to create a containerized environment for building the ISO.
188+
189+
3. **Build the Docker image**: Build the Docker image that will be used to build the ISO.
190+
191+
```bash
192+
docker build -t arch-iso-builder .
193+
```
194+
195+
4. **Run the Docker container**: Use the Docker image to run a container and build the ISO.
196+
197+
```bash
198+
docker run --rm --privileged -v $(pwd):/workdir arch-iso-builder bash -c "mkarchiso -v -w workdir/ -o out/ ."
199+
```
200+
201+
5. **Retrieve the ISO**: After the build process completes, the ISO will be available in the `out/` directory within your local folder as `Arch.iso`.
202+
203+
6. **Set up GitHub Actions**: If you want to use GitHub Actions for automated builds, ensure the workflows in `.github/workflows/` are correctly configured. The `.github/workflows/build.yaml` and `.github/workflows/build-check.yaml` files provide the necessary steps for building and verifying the ISO.
204+
205+
7. **Follow contribution guidelines**: Refer to the `CONTRIBUTING.md` file for detailed instructions on how to contribute to the project, including reporting bugs, submitting fixes, and proposing new features.
206+
207+
8. **Refer to the README**: The `README.md` file provides detailed steps for building the ISO locally and using GitHub Actions. It also includes troubleshooting information for common issues.
208+
209+
---
210+
211+
## Additional Resources for New Contributors
212+
213+
Here are some additional resources and links that can help new contributors get started:
214+
215+
- [Arch Linux Wiki](https://wiki.archlinux.org/): Comprehensive documentation and guides for Arch Linux.
216+
- [Docker Documentation](https://docs.docker.com/): Official Docker documentation and tutorials.
217+
- [GitHub Actions Documentation](https://docs.github.com/en/actions): Official GitHub Actions documentation and guides.
218+
- [Arch Linux Forums](https://bbs.archlinux.org/): Community forums for Arch Linux users and developers.
219+
- [GitHub Guides](https://guides.github.com/): Guides and tutorials for using GitHub effectively.
220+
221+
---
222+
176223
## FAQ
177224

178225
### What is the purpose of this project?

workdir/base._make_custom_airootfs

Whitespace-only changes.

workdir/base._make_packages

Whitespace-only changes.

workdir/base._make_pacman_conf

Whitespace-only changes.

workdir/base._make_work_dir

Whitespace-only changes.

workdir/build_date

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
1739207399

workdir/iso.pacman.conf

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
[options]
2+
CacheDir = /var/cache/pacman/pkg/
3+
HookDir = /workdir/workdir/x86_64/airootfs/etc/pacman.d/hooks/
4+
GPGDir = /etc/pacman.d/gnupg/
5+
DownloadUser = alpm
6+
HoldPkg = pacman
7+
HoldPkg = glibc
8+
Architecture = x86_64
9+
ParallelDownloads = 64
10+
CleanMethod = KeepInstalled
11+
SigLevel = PackageRequired
12+
SigLevel = PackageTrustedOnly
13+
SigLevel = DatabaseOptional
14+
SigLevel = DatabaseTrustedOnly
15+
LocalFileSigLevel = PackageOptional
16+
LocalFileSigLevel = PackageTrustedOnly
17+
[core]
18+
Usage = All
19+
Server = https://geo.mirror.pkgbuild.com/core/os/x86_64
20+
Server = https://mirror.rackspace.com/archlinux/core/os/x86_64
21+
Server = https://mirror.leaseweb.net/archlinux/core/os/x86_64
22+
[extra]
23+
Usage = All
24+
Server = https://geo.mirror.pkgbuild.com/extra/os/x86_64
25+
Server = https://mirror.rackspace.com/archlinux/extra/os/x86_64
26+
Server = https://mirror.leaseweb.net/archlinux/extra/os/x86_64

workdir/iso/arch/version

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
2025.02.10

0 commit comments

Comments
 (0)