I started collecting from users of my project about the problems they face while using it and decided to put it into the documentation. Since right now it's just a single "README" document, I put it together there. The problem is that those are random pieces of advice that IMHO don't justify creating a new section for each of the issues. Because of that, I ended up with a section that looks like the following (context can be found on the GitHub page):
- After having generated a package by aflize, you need to install it. You can run
dpkg -i ~/pkgs/*.debfor that. If dpkg complains about missing dependencies, you can fetch them quickly by calling
apt-get -f install -y.
- Some software is represented by metapackages that point to specific versions of a program. For example, if you want to build Python", you should rather aflize python3.5 ("python3" might not be specific enough either).
- If you're running out of disk space or plan to build a big package, keep in mind that by default Docker allocates 10 GiB per container. Read up on how to increase this value if you plan to build, say, libreoffice.
- Some packages won't build and this can often be a bug that should be reported to the Debian package maintainers. If the "aflize" failed while performing post-build tests, you can still use the resulting binary. Look for it in /root/pkg directory. You can also apply patches at this stage and try just running "make". Sometimes it's that easy.
- If you built a big package, consider submitting it to afl-sid-repo: https://github.com/d33tah/afl-sid-repo. If you're about to build a big package but don't feel like waiting for the process to complete, check this repository out.
Should this be considered bad UX? How could I improve it?