Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add platform-specific setup of the development environment #4

Open
gbraad opened this issue Nov 25, 2024 · 3 comments
Open

Add platform-specific setup of the development environment #4

gbraad opened this issue Nov 25, 2024 · 3 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@gbraad
Copy link
Contributor

gbraad commented Nov 25, 2024

This section

https://github.com/crc-org/engineering-docs/blob/main/content/Developing.md#setting-up-the-development-environment

does not actually contain information about what is needed to set up the development environment;

  • packages?
  • installer
  • suggested base
  • info about cross compile?
@gbraad
Copy link
Contributor Author

gbraad commented Dec 3, 2024

As mentioned in https://crc.dev/engineering-docs/Developing.html#prerequisites it states go, make, and git are needed. However, on Windows this will not result in a working situation that easily. Probably best to describe usage with the gotoolset image, as also set-up with the devcontainer. For this podman is needed... but would have a reliable cross-platform compilation.

@gbraad gbraad self-assigned this Dec 3, 2024
@gbraad gbraad moved this to Work In Progress in Project planning: crc Dec 3, 2024
@gbraad gbraad added the documentation Improvements or additions to documentation label Dec 3, 2024
@gbraad
Copy link
Contributor Author

gbraad commented Dec 3, 2024

@anjannath and @rohanKanojia WDYT?

@rohanKanojia
Copy link

In my opinion, we should have separate Operating System specific instructions for any additional platform-specific requirement. If you want I can give it a try to check development setup requirements on windows and Linux.

I'm not sure about devcontainer , I have never used it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: Work In Progress
Development

No branches or pull requests

2 participants