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

Explicitly document --features and their dependencies in Getting Started Guide #1093

Open
katrinabrock opened this Issue Aug 13, 2017 · 3 comments

Comments

2 participants
@katrinabrock
Contributor

katrinabrock commented Aug 13, 2017

I'm happy to submit a PR for this soon.

Problem Description

"A Note on Installing diesel_cli" is helpful, but could be way more helpful to make install painless.

Two main things

  1. Possible arguments to --features (backends) should be explicitly listed. Maybe there is a cargo way to figure out what they are? Even if there is, it would be nice to explicitly list them in the getting started guide to make it rust-beginner friendly.

  2. For each backend, it would be nice to list the exact package name needed for various OS package managers (brew, apt-get, dnf, do we need to cover Windows?)

Checklist

  • I have already looked over the issue tracker for similar issues.
@killercup

This comment has been minimized.

Member

killercup commented Aug 13, 2017

Yes please! I'm not sure I'd put all that in the Getting Started guide, though. Maybe add a new document about all the feature toggles Diesel has? The 3 backends are the relevant ones for the CLI, and a good start; but the same document could also talk about the features you need to enable in diesel (and diesel-codegen) to get DateTime, JSON, etc. support.

@katrinabrock

This comment has been minimized.

Contributor

katrinabrock commented Aug 13, 2017

For a guide to installing dependencies, do we need to cover windows or just Mac and common Linux flavors?

@killercup

This comment has been minimized.

Member

killercup commented Aug 13, 2017

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment