GERSL / pycold

Apache License 2.0
19 stars 9 forks source link

Update README #6

Closed Erotemic closed 2 years ago

Erotemic commented 2 years ago

This PR is to mainly test the new CI, but it includes a bunch of updates to the README.

There are less updates than it would seem, but I changed the README from a markdown file to an RST file so I could put comments in it. I've updated a lot of the instructions in an attempt to be more clear, added relevant links, and put shiny new CI badges on the top.

EDIT: Hmm, the CI checks aren't immediately showing up. I wonder if it takes time or if there is an issue in the actions yaml?

EDIT EDIT: Yes, looks like the actions only run on PRs against "main" I changed it to also run against "devel".