search

citation-file-format / cffconvert

Command line program to validate and convert CITATION.cff files.
Apache License 2.0
100 stars 28 forks source link

how to install latest beta version #393

Open jcolomb opened 1 month ago

jcolomb commented 1 month ago

Hello,

I see some issues about converting "type: dataset" from cff to json has been resolved, but I can only use the version 2 of the software (release in 2021) while the patch is from 2023.

I did not see any indication about installing the latest version of cff (from the git repo directly?) It might be straightforward for python users, but I am not one ...

kevinmatthes commented 1 month ago

Hello, @jcolomb!

Please have a look at this manual page of pip: https://pip.pypa.io/en/stable/cli/pip_install/#examples. Example number 5 seems to me relevant for your question. In your case, you would just need to skip the SomeProject@ part at the beginning and use main at the end instead of 1.3.1, just as shown in 4th line of example 6.

Does this answer your question?

jcolomb commented 1 month ago

pip install 'cffconvert@git+https://github.com/citation-file-format/cffconvert@main' worked !

should I open a PR to add it in the readme ?

kevinmatthes commented 1 month ago

Glad to hear that this suggestion was helpful for you! 👍

Regarding the documentation's enhancement, I would like to suggest waiting for one of the maintainers to approve the work on a PR since this procedure is recommended in the project's Contribution Guidelines.

@jspaaks, what do you think about adding instructions for the installation of a pre-release version to the project's documentation?