docs(README): rework README header and content #346
+49
−21
Conversation
This file contains hidden or 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
|
rebased and dropped commits |
Signed-off-by: Stefano Serioli <[email protected]> docs(README): adjust h tags
cadriel
reviewed
Jul 3, 2021
| A big thank you to; | ||
|
|
||
| - 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!
|
This looks sweet. Lets merge it! |
matmen
requested changes
Feb 21, 2022
|
|
||
| Older releases can be found [here](https://github.com/cadriel/fluidd/releases). | ||
| - 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
| - Customize you dashboard! Choose what you want to see and move every panel where YOU want! | |
| - Customize your dashboard! Choose what you want to see and move every panel where YOU want! |
|
|
||
| ## How to use? | ||
| Fluidd is distributed as a RaspbiOS image, with Fluidd pre-installed and setup alongside its dependencies. | ||
|
|
||
| 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
| Please see the [docs](https://docs.fluidd.xyz) for help with installation and configuration. | |
| Please refer to the [docs](https://docs.fluidd.xyz/installation) for help with installation and configuration. |
| Fluidd is distributed as a RaspbiOS image, with Fluidd pre-installed and setup alongside its dependencies. | ||
|
|
||
| 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. | ||
|
|
||
| ### Credit | ||
| # Credit | ||
| A big thank you to; |
There was a problem hiding this comment.
Suggested change
| A big thank you to; | |
| A big thank you to: |
matmen
added
the
Docs - Enhancement
|
Hey @StuSerious, any feedback to my comment? I love the new readme in this! |
|
@matmen @pedrolamas I have some time to finish this up on Sunday. Is there anything else that needs to be added/removed since this is quite old? |
Only thing I can think of is that all the links to https://github.com/cadriel/ need to be reviewed and probably changed to https://github.com/fluidd-core/ |
matmen
reviewed
Jul 4, 2022
| https://hub.docker.com/r/cadriel/fluidd | ||
| # 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="GitHub closed issues" src="https://img.shields.io/github/issues-closed/cadriel/fluidd?style=flat-square"></a> | |
| <a href="https://github.com/fluidd-core/fluidd/issues" target="__blank"><img alt="GitHub open issues" src="https://img.shields.io/github/issues/cadriel/fluidd?style=flat-square"></a> |
|
|
||
|  | ||
| <h4 align="center"> | ||
| <a href="https://github.com/cadriel/fluidd/releases/latest/download/fluidd.zip">📜 Download</a> |
There was a problem hiding this comment.
Suggested change
| <a href="https://github.com/cadriel/fluidd/releases/latest/download/fluidd.zip">📜 Download</a> | |
| <a href="https://github.com/fluidd-core/fluidd/releases/latest/download/fluidd.zip">📜 Download</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
| <a href="https://github.com/cadriel/fluidd/blob/master/CONTRIBUTING.md">🧱 Contribute</a> | |
| <a href="https://github.com/fluidd-core/fluidd/blob/master/CONTRIBUTING.md">🧱 Contribute</a> |
| - Manage multiple printers from one Fluidd install | ||
| - [See our docs for more!](https://docs.fluidd.xyz) | ||
| <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 release (latest by date)" src="https://img.shields.io/github/v/release/cadriel/fluidd?label=latest&style=flat-square"></a> | |
| <a href="https://github.com/fluidd-core/fluidd/releases/latest" target="__blank"><img alt="GitHub release (latest by date)" src="https://img.shields.io/github/v/release/fluidd-core/fluidd?label=latest&style=flat-square"></a> |
| <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
| Looking for support? [Check out our docs](https://docs.fluidd.xyz) or [open an issue](https://github.com/cadriel/fluidd/issues/new/choose)! | |
| Looking for support? [Check out our docs](https://docs.fluidd.xyz) or [open an issue](https://github.com/fluidd-core/fluidd/issues/new/choose)! |
| 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
| 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). | |
| You can get your hands on the latest release of *fluidd* [here](https://github.com/fluidd-core/fluidd/releases/latest), while older releases can be found [here](https://github.com/fluidd-core/fluidd/releases). |
| <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> | ||
| <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="Docker Pulls" src="https://img.shields.io/docker/pulls/cadriel/fluidd?style=flat-square"></a> | |
| <a href="https://hub.docker.com/r/cadriel/fluidd" target="__blank"><img alt="Docker Pulls" src="https://img.shields.io/docker/pulls/cadriel/fluidd?style=flat-square"></a> |
| <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> | ||
| <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
| <img alt="GitHub commit activity" src="https://img.shields.io/github/commit-activity/m/cadriel/fluidd?style=flat-square"></a> | |
| <a href="https://github.com/fluidd-core/fluidd/commits/develop" target="__blank"><img alt="GitHub commit activity" src="https://img.shields.io/github/commit-activity/m/cadriel/fluidd?style=flat-square"></a> |
matmen
reviewed
Jul 6, 2022
|
|
||
| ## How to use? | ||
| 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
| Fluidd is distributed as a RaspbiOS image, with Fluidd pre-installed and setup alongside its dependencies. | |
| Fluidd is distributed as a Raspberry Pi OS image, with Fluidd pre-installed and setup alongside its dependencies. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
sqashed:
Signed-off-by: Stefano Serioli [email protected]
TODOs: