BlueOS icon indicating copy to clipboard operation
BlueOS copied to clipboard

Improve first time setup for new devs

Open nicoschmdt opened this issue 6 months ago • 0 comments

While setting up my environment I encountered some undocumented or hard-to-find steps that could be improved for newcomers.To enhance the Development section in the wiki page as a way to make it more begginer-friendly, I suggest we:

  • Add a sub section in "How to build" suggesting the use of DockerHub as an alternative to buildx;
  • Add a README.md for frontend debugging including the dependencies for bun and the BLUEOS_ADDRESS=http://<BLUEOS_IP> bun run dev command;
  • Add the execution of git submodule update --init --recursive in the setup steps;
  • Add a note to inform that depending on the OS (e.g. Arch Linux) it will be necessary to configure Avahi to identify and access the BlueOS on blueos-avahi.local.
  • Link the Development Wiki with the BlueOS docs and vice-versa, or just unify everything in one place;
  • When configuring buildx locally I had to do two extra steps:
  1. install qemu-user-static-binfmt and qemu-user-static
  2. execute docker run --privileged --rm tonistiigi/binfmt --install all

Lastly, I think it would be nice to link the Developer Wiki from the main README.md.

nicoschmdt avatar Aug 11 '25 19:08 nicoschmdt