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

Cleanup the README.md file #9

Open
abetusk opened this issue Nov 9, 2020 · 0 comments
Open

Cleanup the README.md file #9

abetusk opened this issue Nov 9, 2020 · 0 comments

Comments

@abetusk
Copy link
Contributor

abetusk commented Nov 9, 2020

The README.md looks, to me at least, disorganized and hard to navigate.

I propose the following cleanup:

  • Provide a graphic of the OSHW certification under the "Certification Mark Generate" that will redirect to the certification-mark-generate page (using the default certification graphic should do)
  • Change all fully qualified links to shorter links without the https and in front of them
  • Provide graphics under the "Pregenerated" section in addition to the links that link to the same svg as the links
  • Change the link the template fact sheet (svg) links to the fact generation page (that is certification-mark-generator/facts)
  • Each of the headers should link to the thing they describe. That is the "Certification Mark Generator" should link to the certification mark generator page, the "Open Hardware Facts" header should be changed to link directly to the fact generator page.
  • The "Open Hardware Facts" header should be changed to be the same size as the "Open Hardware Facts"

The principle behind each of the these suggestions is "least surprise". Graphics should link to either the page they're describing or the actual graphic they're showing. Fully qualified links distracts from the place they're linking to.

I find myself coming to this page for the "Open Hardware Facts" generation page more than the "Certification Mark Generator" as I have projects that I want to document but not necessarily create OSHW certifications for. There is one link nestled in among the others that actually redirects to the "facts" page with two of the three linking to something superfluous under the "Open Hardware Facts" section.

abetusk added a commit to abetusk/certification-mark-generator that referenced this issue Nov 9, 2020
Making README more readable as per issue oshwa#9
jywarren added a commit that referenced this issue May 30, 2021
* Resolves issue #7, #8

* initially 'click' the go button (js call)
* add download option with radio buttons to select option for graphic type
  to download
* minimal javascript infrastructure to allow for different download
  options and size options (not user facing but there for the future if
  need be).

* adding certification template

* index.svg was giving problems when rendering. This svg allows for
  a preview image

* Resolves issue #9, cleaning up README

Making README more readable as per issue #9

* Adding image link to 'facts' section

* Finally getting markdown image link right

* Markdown image link for certification

* bug fix, downloads jpg

* border pixel pix (jpg,png)

* Downloading the 'facts' graphic (png,jpg), the border pixel was getting
  cutoff becaues, I think, the width/height were non-integral
* To fix, round up to nearest integer for width and height

Co-authored-by: Jeffrey Warren <jeff@unterbahn.com>
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

No branches or pull requests

1 participant