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

Extend README with description of command line tools. #51

Merged

Conversation

filippodebortoli
Copy link
Collaborator

I sketched an extension of the README where the tools associated with horned are briefly presented.
This should allow the user to get to use them without having to look at the source code of each subcommand.

I also added a few lines on how to include the library in Cargo.toml (redundant given the existence of crates.io) and shields that point to the crates.io and docs.rs pages associated to horned.

The compare module was not included in horned.rs and the tool was as such excluded from the main command line tool.
…roject.

It also adds shields linking to crates.io and docs.rs.
@phillord
Copy link
Owner

While I think this is good, I have been thinking for a while about removing the binaries to their own crate. Or to refactor the repo, probably, into a multi-crate workspace. This didn't make sense originally, but now there is a good way of using horned without using the binaries, it probably does now.

What are your thoughts on this?

@althonos
Copy link
Collaborator

I'd be in favour of splitting the crate into a multi-crate, as right now compiling fastobo-owl means building horned-owl and compiling the code / dependencies for the binaries (such as clap) that are not used in the library interface 👍

@phillord phillord merged commit c5bc8dc into phillord:devel Dec 22, 2022
@phillord
Copy link
Owner

phillord commented Dec 22, 2022

I am inclined then to do this. As this will be a substantial change to the code base, it will probably merit a release all by itself.

@filippodebortoli
Copy link
Collaborator Author

While I think this is good, I have been thinking for a while about removing the binaries to their own crate. Or to refactor the repo, probably, into a multi-crate workspace. This didn't make sense originally, but now there is a good way of using horned without using the binaries, it probably does now.

What are your thoughts on this?

I am also in favor of the split.
Like @althonos, I am only interested in using the library and as such, I would be happier with a lightweight dependency.
Plus, I think it generally makes sense to have a library and then separate crate(s) for the tools.

@filippodebortoli filippodebortoli deleted the readme/add-description-tools branch February 1, 2023 14:57
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

Successfully merging this pull request may close these issues.

None yet

3 participants