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

Mention dependencies gcc and make #13

Open
klappradla opened this issue Nov 13, 2019 · 1 comment
Open

Mention dependencies gcc and make #13

klappradla opened this issue Nov 13, 2019 · 1 comment
Assignees

Comments

@klappradla
Copy link
Member

I don't know whether this should be on the guides, but make and gcc are also required to compile scenic. I usually run my projects inside Docker and these packages are usually provided by the images, so I didn`t have them installed locally.

Originally posted by @LuisaAPF in #11 (comment)

With gcc and make being sort of "hidden" dependencies for Scenic, we should mention them somewhere. Either put a separate step into the guide checking for them, or link to a TROUBLESHOOTING.md file where we list things like that.

I'm currently leaning more towards the 2nd approach. It feel like it's easier to maintain and that it would also scale for other "eventual" troubles with the guide. gcc and make are from what I remember part of lot of distros already. Still, getting into the details of how install them on other platforms may be a bit hard to maintain and test for us. Let's see.

@klappradla klappradla self-assigned this Nov 13, 2019
@jvf
Copy link
Contributor

jvf commented Nov 27, 2019

I am also in favour of a troubleshooting guide or section, it allows to keep the main instructions brief and to not cover every edge case. Still super useful to document the edge we encountered.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants