Skip to content
This repository has been archived by the owner on Sep 22, 2022. It is now read-only.

Set up CI #3

Open
carrascomj opened this issue Nov 10, 2020 · 4 comments · May be fixed by #4
Open

Set up CI #3

carrascomj opened this issue Nov 10, 2020 · 4 comments · May be fixed by #4

Comments

@carrascomj
Copy link
Contributor

Hi!

I noticed there is not Continuous Integration for this one. Let me know if a PR (github actions I suppose) for that would be interesting.

@ztlpn
Copy link
Owner

ztlpn commented Nov 10, 2020

Yes, that would be a welcome addition!

@carrascomj
Copy link
Contributor Author

Cool! I'll submit one workflow with the starter pack clippy, fmt, build and test.

I also saw that you have the same README as in the docs, so it could be automatically generated with cargo-readme like in this one (the examples in github's would be always valid), but let's just go with CI for now.

@ztlpn
Copy link
Owner

ztlpn commented Nov 10, 2020

Yeah, I've considered using cargo-readme, but ultimately decided against it because I wanted the README and the frontpage of the docs be a bit different.

@carrascomj carrascomj linked a pull request Nov 11, 2020 that will close this issue
@carrascomj
Copy link
Contributor Author

Right, it's not always the best fit for every project. It also may be an overkill for only one example in the README.

Still, at least for now, it seems like the README.md here just have additions with respect to the one from lib.rs, so something like this README.tlp could be used in this case (it is used by cargo-readme by defautl). If you are planning to make them more different it won't work, of course.

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 a pull request may close this issue.

2 participants