search

Ultimaker / cura-build-environment

CMake project to build dependencies for Cura
GNU Affero General Public License v3.0
24 stars 55 forks source link

Please update README #121

Open McNugget6750 opened 2 years ago

McNugget6750 commented 2 years ago

I'm following the readme closely but multiple things are not working as intended. The need for a docker install as a precursor isn't mentioned at all.

It's unclear whether docker pull ultimaker/cura-build-environment is sufficient under Windows or if the steps below need to be taken too, and to what extend. CURA_BUILD_ENV_BUILD_TYPE has not value as default when running the docker image cli.

This doesn't work and it's unclear whether this has to be executed within the image cli or (more likely) PowerShell: docker build \ --build-arg CURA_BUILD_ENV_BUILD_TYPE=Release \ --build-arg CURA_ARCUS_BRANCH_OR_TAG=master \ ...

Instructions provided here (https://github.com/Ultimaker/cura-build-environment#details-about-the-linux-centos-7-docker-image) differ from the contents of the file in the actual image. There is no mention as to how to run this or if it needs to be run manually at all. I chose to run this using: ./docker-entrypoint.sh

From there, there are no instructions on how to proceed. Essentially, the documentation ends there which no build or compile taking place at all.

I documented what I did here: https://hackaday.io/project/184097-my-adventure-to-compile-cura-from-source

Ghostkeeper commented 2 years ago

You wrote that you'd prefer to have a virtual machine set up for you that you could download. That is precisely what Docker intends to do here. Docker is sort of a virtual machine (but not quite, since if the operating system is the same it will merely run in a sandbox that pretends it's a separate computer). docker pull ultimaker/cura-build-environment will pull in this virtual machine with the basis of Cura's dependencies pre-installed.

There definitely needs to be an update to the documentation, especially after our nightmare with updating Sip to v6 is over. We're in the middle of updating Qt to Qt6, Python to 3.10 and our Linux build system to Debian. This doesn't make it easier for someone to come in halfway and try to work with the outdated documentation. This upgrade has been a nightmare the past 6 weeks, but outdated documentation will bite us in the rear later if we don't update it.

fvrmr commented 2 years ago

I created a ticket for this, see CURA-9047