From 551d9684fe41583d374231da8679b3ef3701f140 Mon Sep 17 00:00:00 2001 From: Florian Heilmann Date: Wed, 13 Nov 2019 21:48:38 +0100 Subject: [PATCH] PoC for new README.md format --- firmware_configurations/README.md | 43 +++++++++++-------------------- 1 file changed, 15 insertions(+), 28 deletions(-) diff --git a/firmware_configurations/README.md b/firmware_configurations/README.md index 2a794196d..0034166e7 100644 --- a/firmware_configurations/README.md +++ b/firmware_configurations/README.md @@ -1,39 +1,26 @@ # Firmware Configurations -A neatly structured list of all the content in each folder +Firmware Configurations for Voron 3D printers, separated by firmware. Remember to update this README when uploading new firmware configurations! -## List structure +## Table structure -The list should be structured in the following way: +Update the following table with the information about your mod: +- Your name +- A link to your sub-folder +- A short description of your firmware +- The printer compatibility. Use `:heavy_check_mark:` for :heavy_check_mark: and `:x:` for :x: -## "Creator of mods" - -"Firmware configuration name" - -- "Small description about the firmware config" - -"Firmware configuration 2 name" - -- "Small description about the firmware config" +like so: +` +| Creator | [Config Title](link) | Description | :x: | :x: | :x: |` --- -## Chron -[SKR 1.3 TMC2208 UART Config](./klipper/Chron) - -- Configuration for SKR 1.3 TMC2208 UART - -## Danowar - -[FYSETC F6 1.3 Klipper Config](./klipper/Danowar/FYSETC_F6_V1.3_Klipper_Config) - -- Klipper config for a FYSETC F6 350 build. - -## exquyre - -[Einsy + RAMPS Combo](./klipper/exquyre/einsy%2Bramps) - -- Klipper config for 1 einsy and 1 RAMPS +| Creator | Config title | Description | V1.6 | V2.1 | V2.2 | +|---------|--------------|-------------|------|------|------| +| Chron | [SKR 1.3 TMC2208 UART Config](./klipper/Chron) | Configuration for SKR 1.3 TMC2208 UART | :x: | :heavy_check_mark: | :heavy_check_mark: | +| Danowar | [FYSETC F6 1.3 Klipper Config](./klipper/Danowar/FYSETC_F6_V1.3_Klipper_Config) | Klipper config for a FYSETC F6 350 build. | :x: | :heavy_check_mark: | :heavy_check_mark: | +| exquyre | [Einsy + RAMPS Combo](./klipper/exquyre/einsy%2Bramps) | Klipper config for 1 einsy and 1 RAMPS | :x: | :heavy_check_mark: | :heavy_check_mark: | ---