gbasis icon indicating copy to clipboard operation
gbasis copied to clipboard

Update README

Open msricher opened this issue 1 year ago • 1 comments

Updates the README to be consistent with other QC-Devs projects.

I moved the installation notes into the website and linked to it from the README.

Since there is no release yet, and CodeFactor is not integrated, I have commented out those "badge" images in the README header for now.

Checklist

  • [x] Write a good description of what the PR does.
  • [x] Add tests for each unit of code added (e.g. function, class)
  • [x] Update documentation
  • [x] Squash commits that can be grouped together
  • [ ] Rebase onto master

Type of Changes

Type
:bug: Bug fix
:sparkles: New feature
:hammer: Refactoring
:scroll: Docs

Related

msricher avatar Jun 24 '24 14:06 msricher

I would say that this is a partial list of features, as the Readme may rarely be entirely up-to-date. Perhaps say, instead,

Selected Features

or

Features (Partial List)

Done. I also linked some parts to the website.

msricher avatar Jun 25 '24 00:06 msricher