docs(README): rework README header and content #346
+49
−21
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -1,38 +1,66 @@ | ||||||
| <h4 align="center"> | ||||||
| <img src="docs\assets\images\fluidd_icon.svg"> | ||||||
| </h4> | ||||||
|
|
||||||
| <h4 align="center"> | ||||||
| <a href="https://github.com/cadriel/fluidd/releases/latest/download/fluidd.zip">📜 Download</a> | ||||||
| | | ||||||
| <a href="https://docs.fluidd.xyz/">📖 Docs</a> | ||||||
| | | ||||||
| <a href="https://docs.fluidd.xyz/faq">💭 FAQ</a> | ||||||
| | | ||||||
| <a href="https://docs.fluidd.xyz/configuration">⚙️ Configs</a> | ||||||
| | | ||||||
| <a href="https://github.com/cadriel/fluidd/blob/master/CONTRIBUTING.md">🧱 Contribute</a> | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
| </h4> | ||||||
|
|
||||||
| <h4 align="center"> | ||||||
| <a href="" target="__blank"><img alt="GitHub release (latest by date)" src="https://img.shields.io/github/v/release/cadriel/fluidd?label=latest&style=flat-square"></a> | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
| <a href="" target="__blank"><img alt="GitHub downloads" src="https://img.shields.io/github/downloads/cadriel/fluidd/total?style=flat-square"></a> | ||||||
| <a href="" target="__blank"><img alt="Docker Pulls" src="https://img.shields.io/docker/pulls/cadriel/fluidd?style=flat-square"></a> | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
| <a href="" target="__blank"><img alt="GitHub language count" src="https://img.shields.io/github/languages/count/cadriel/fluidd?style=flat-square"></a> | ||||||
| <img alt="GitHub commit activity" src="https://img.shields.io/github/commit-activity/m/cadriel/fluidd?style=flat-square"></a> | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
| </h4> | ||||||
|
|
||||||
| <img align="right" src=".github\images\community-logos.png" alt="Community Logos" width="250"/> | ||||||
|
|
||||||
| ## Key Features | ||||||
|
|
||||||
| - Responsive UI made for *desktop, tablet & mobile*! | ||||||
| - Customize you dashboard! Choose what you want to see and move every panel where YOU want! | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
| - Built-in color and community themes, pick a logo you like! | ||||||
| - Manage multiple printers from one Fluidd install! | ||||||
| - Fast development cycle and active devs! | ||||||
| - Multi language support! | ||||||
| - [See our docs for a lot more!](https://docs.fluidd.xyz) | ||||||
|
|
||||||
| # Support & Documentation | ||||||
| <p> | ||||||
| <a href="" target="__blank"><img alt="GitHub closed issues" src="https://img.shields.io/github/issues-closed/cadriel/fluidd?style=flat-square"></a> | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
| <a href="" target="__blank"><img alt="Discord" src="https://img.shields.io/discord/762863525818662974?label=discord&style=flat-square&logo=discord"></a> | ||||||
| </p> | ||||||
|
|
||||||
| Looking for support? [Check out our docs](https://docs.fluidd.xyz) or [open an issue](https://github.com/cadriel/fluidd/issues/new/choose)! | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
|
|
||||||
| Have a killer idea you'd like to see implemented? Join our [Discord](https://discord.gg/GZ3D5tqfcF) to discuss bugs, features and share fireside fluidd stories. | ||||||
|
|
||||||
| # Where can I get it? | ||||||
| You can get your hands on the latest release of *fluidd* [here](https://github.com/cadriel/fluidd/releases/latest), while older releases can be found [here](https://github.com/cadriel/fluidd/releases). | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
|
|
||||||
| We also have an official docker image! This is updated for each release and can be found [here](https://hub.docker.com/r/cadriel/fluidd). | ||||||
|
|
||||||
|
|
||||||
| # How do I use it? | ||||||
|
|
||||||
| Fluidd is distributed as a RaspbiOS image, with Fluidd pre-installed and setup alongside its dependencies. | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
|
|
||||||
| The recommended approach is to flash a fresh image using FluiddPI. | ||||||
|
|
||||||
| Please see the [docs](https://docs.fluidd.xyz) for help with installation and configuration. | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
|
|
||||||
| # Credit | ||||||
| A big thank you to; | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
|
|
||||||
| - the [Voron Community](http://vorondesign.com/) | ||||||
|
There was a problem hiding this comment. Should we add the other communities here? There was a problem hiding this comment. Great idea, let me add those! |
||||||
| - Kevin O'Connor for [Klipper](https://github.com/KevinOConnor/klipper) | ||||||
| - Eric Callahan for [Moonraker](https://github.com/Arksine/moonraker) | ||||||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.