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

First time usage tutorial missing #7

Open
saphieron opened this issue Aug 6, 2019 · 0 comments
Open

First time usage tutorial missing #7

saphieron opened this issue Aug 6, 2019 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@saphieron
Copy link
Contributor

For admittedly lack of where else to put this issue:

The current documentation is not precise enough to hand to first time users.

A basic introduction into the different bazel components are required.
Questions that came up during the first time usage:

  • What are the different BUILD files for? What has do be defined in the WORKSPACE file?
  • How are dependencies added to a newly created project? E.g. the communication library. In which bazel files do we need to change/add things.
  • What are the platform options available? in the Communication library some information is give e.g. deps = ["@CommunicationModule//Setup:MotherboardSetup"], but there does not seem to be any documentation that lists the currently implemented platforms or at least where to find them.
  • More (cross)documentation needs to be added to get an idea where to look in the other repos

Using CLion:

  • How is a newly created project imported?
  • What is bazel sync/ blaze? How and when do we use it?
  • How does a build configuration have to be defined, to be used in CLion?
  • What options exist in the build configuration?

Probably more that I forgot, but they can likely be reproduced by letting someone new try it again.

@saphieron saphieron reopened this Aug 6, 2019
@glencoe glencoe added documentation Improvements or additions to documentation enhancement New feature or request labels Aug 26, 2019
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 enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants