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

docs(README): rework README header and content #346

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

docs(README): rework README header and content #346

wants to merge 1 commit into from

Conversation

StuSerious
Copy link
Collaborator

@StuSerious StuSerious commented Jul 1, 2021

sqashed:

  • docs(README): adjust h tags

Signed-off-by: Stefano Serioli stefano.serioli@outlook.com

TODOs:

  • passes checks
  • confirm text content is OK
  • confirm image directory is OK
  • add shield for other titles as well?
  • move everything to HTML formatting?
  • check this box

@StuSerious
Copy link
Collaborator Author

StuSerious commented Jul 2, 2021

github DT screwed around with the commits, I accidentally merged

should I close and resubmit?

rebased and dropped commits

Signed-off-by: Stefano Serioli <stefano.serioli@outlook.com>
docs(README): adjust h tags
A big thank you to;

- the [Voron Community](http://vorondesign.com/)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we add the other communities here?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great idea, let me add those!

@cadriel
Copy link
Member

cadriel commented Jul 3, 2021

This looks sweet. Lets merge it!

@StuSerious StuSerious marked this pull request as ready for review July 5, 2021 07:02

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!
Copy link
Member

@matmen matmen Feb 21, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.
Copy link
Member

@matmen matmen Feb 21, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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;
Copy link
Member

@matmen matmen Feb 21, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
A big thank you to;
A big thank you to:

@matmen matmen added the Docs - Enhancement Pertaining improvements or suggestions for the Docs label Feb 22, 2022
@matmen matmen added the GH - Waiting for Feedback Waiting for the issuer to reply label Mar 19, 2022
@matmen
Copy link
Member

matmen commented Mar 23, 2022

Hey @StuSerious, any feedback to my comment? I love the new readme in this!

@StuSerious
Copy link
Collaborator Author

@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?

@pedrolamas
Copy link
Member

pedrolamas commented Jun 16, 2022

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/

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>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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>


![Fluidd](/.github/images/preview_sliced.png?raw=true "Fluidd")
<h4 align="center">
<a href="https://github.com/cadriel/fluidd/releases/latest/download/fluidd.zip">📜 Download</a>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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>

&nbsp;|&nbsp;
<a href="https://docs.fluidd.xyz/configuration">⚙️ Configs</a>
&nbsp;|&nbsp;
<a href="https://github.com/cadriel/fluidd/blob/master/CONTRIBUTING.md">🧱 Contribute</a>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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)!
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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>


## How to use?
Fluidd is distributed as a RaspbiOS image, with Fluidd pre-installed and setup alongside its dependencies.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
Labels
Docs - Enhancement Pertaining improvements or suggestions for the Docs GH - Waiting for Feedback Waiting for the issuer to reply
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants