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

Project layout #28

Open
lu-zero opened this issue May 10, 2024 · 2 comments
Open

Project layout #28

lu-zero opened this issue May 10, 2024 · 2 comments

Comments

@lu-zero
Copy link
Contributor

lu-zero commented May 10, 2024

Since it is a workspace with 3 components:

  • crate library
  • ffi for the crate library
  • cli utilities

It is common to either have

  • The crate library as root crate, ffi and cli in crates/ as v4l2r-ffi and v4l2r-cli
  • Everything in crates/ as v4l2r, v4l2r-ffi, v4l2r-cli.

Are you fine with either refactor?

@Gnurou
Copy link
Owner

Gnurou commented May 10, 2024

Having the library as the root crate sounds definitely like a better design, in fact IIRC I wanted to go with something like that but couldn't do it for some reason.

Is having secondary crates in crates/ a convention? I'm also not sure if we can talk about cli utilities, there are examples that are maybe a bit more involved than what one would expect, but I'd not go as far as suggesting they can actually be useful to something other than testing. :)

In any case let's make sure to clearly define the layout before doing any groundwork.

@lu-zero
Copy link
Contributor Author

lu-zero commented May 10, 2024

crates/ is commonly used to keep everything tidy, but not always used. Naming-wise it is common to have those names though.

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