qmk / qmk_firmware

Open-source keyboard firmware for Atmel AVR and Arm USB families
https://qmk.fm
GNU General Public License v2.0
18.35k stars 39.52k forks source link

Keyboard Readme Refresh #1588

Closed skullydazed closed 2 years ago

skullydazed commented 7 years ago

This is a master issue to track the ongoing work to update keyboard readme.md files. These keyboards need to be updated still:

This is a sample of the readme format:


Planck
===

![Planck](http://i.imgur.com/q2M3uEU.jpg)

A compact 40% (12x4) ortholinear keyboard kit made and sold by OLKB and Massdrop. [More info on qmk.fm](http://qmk.fm/planck/)

Keyboard Maintainer: [Jack Humbert](https://github.com/jackhumbert)  
Hardware Supported: Planck PCB rev1, rev2, rev3, rev4, Teensy 2.0  
Hardware Availability: [OLKB.com](https://olkb.com), [Massdrop](https://www.massdrop.com/buy/planck-mechanical-keyboard?mode=guest_open)

Make example for this keyboard (after setting up your build environment):

    make planck-rev4-default

See [build environment setup](https://docs.qmk.fm/build_environment_setup.html) then the [make instructions](https://docs.qmk.fm/make_instructions.html) for more information.

There needs to be two spaces at the end of the Keyboard Maintainer and Hardware Supported lines for it to render correctly with Markdown.

nooges commented 7 years ago

There needs to be blank lines in between "Keyboard Maintainer", "HW Supposed", etc., otherwise, the lines get mushed together when the Markdown parser is run on it, like this:

image

Or add bullet points to the beginning of each of those lines.

jackhumbert commented 7 years ago

Ah, thanks! I think I was planning on noting that there should be two spaces at the end of each line, but it slipped my mind :)

ryanmaclean commented 7 years ago

Can you look at your line endings for that default readme? Currently there aren't any, and they display as one line on github. Perhaps a table would be best?

jackhumbert commented 7 years ago

Yeah, the ones that were changed previously need those spaces added in - I've only just added them to the example here, not the actual files!

github-actions[bot] commented 2 years ago

This issue has been automatically marked as stale because it has not had activity in the last 90 days. It will be closed in the next 30 days unless it is tagged properly or other activity occurs. For maintainers: Please label with bug, in progress, on hold, discussion or to do to prevent the issue from being re-flagged.

tzarc commented 2 years ago

Closing due to inactivity.