Skip to content
This repository was archived by the owner on Oct 10, 2023. It is now read-only.

README: add a brief requirements section#33

Merged
cole-h merged 3 commits intomainfrom
cole/ds-237
Aug 22, 2022
Merged

README: add a brief requirements section#33
cole-h merged 3 commits intomainfrom
cole/ds-237

Conversation

@cole-h
Copy link
Copy Markdown
Member

@cole-h cole-h commented Aug 19, 2022

Waiting on the discussion at #28 (comment) to come to a conclusion so I can update the names.

@linear
Copy link
Copy Markdown

linear bot commented Aug 19, 2022

DS-237 Document how to describe package requirement inputs

With DS-209 we got the ability to embed package requirements into Cargo.toml files. Let's start building out the documentation for the tool by describing how to do this for your own crate.

@grahamc
Copy link
Copy Markdown
Member

grahamc commented Aug 22, 2022

Is this still a draft / @Hoverbear what do you think about using the link to the install page?

@cole-h cole-h marked this pull request as ready for review August 22, 2022 15:48

* `build-inputs`, which are native dependencies that the crate may want to link against.
* `environment-variables`, which are environment variables you may want to set in your dev shell.
* `runtime-inputs`, which are libraries you may want to add to your `LD_LIBRARY_PATH` to ensure proper execution in your dev shell.
Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Slightly reworded, since I realized that LD_LIBRARY_PATH isn't for linking (commonly meaning "linking during the build in order to produce a binary"), but more for execution of the built binary.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think that this term is nice.

@cole-h cole-h mentioned this pull request Aug 22, 2022
@cole-h cole-h enabled auto-merge August 22, 2022 15:54
@cole-h cole-h merged commit 1cfb72c into main Aug 22, 2022
@grahamc grahamc deleted the cole/ds-237 branch August 22, 2022 16:33
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants