Add a recommendation

Thank you for taking the time to suggest a recommendation!

WIP

This page is not complete or may be inaccurate.

Is it worth adding to the list?

It's worth pausing to ask yourself a handful of quick questions that help ensure the entry truly fits the community's standards. These questions mirror the guidance you'll find in the recommendations index:

1. Is it free and open-source (FOSS)?

• Does the project provide source code for the entire package under a permissive license (FOSS), or at least a source-available version that can be compiled by anyone (using 100% open-source toolchains)?
• Check the license field in the RecCard - it should be a permissive or copyleft license (MIT, GPL, Apache, etc.).

2. Does it rely on binary blobs?

• Does your software have required blobs?
  • If it's required, the software depends on proprietary drivers or firmware. That may disqualify it unless you're willing to explain why it's still recommended.
• Are they included? They might also be situational in some cases.

3. Is the software actively maintained?

• Verify the project's repository has recent commits and an active issue tracker.
• Look for recent releases or tags that indicate ongoing support.

4. Does it align with our privacy-first mission?

• Is the software designed to protect user privacy or is local-only?
• Does it avoid telemetry or data-collection practices that could undermine privacy?

5. Are the ratings meaningful?

• Provide clear criteria for each rating (e.g., "Security", "Performance", "Ease of Use").
• Explain why you gave a particular score in ratingWhy.

Add your recommendation

website/docs/recommendations/category.mdx

import { RecCard } from "@site/src/components/RecCard";
import { Cpu } from "lucide-react";

# Category

## ProjectABC
<RecCard
  // icon:
  // If the project is in https://simpleicons.org, we recommend using it
  // by passing the icon name as a string, for example: icon="Librewolf"
  // Do note that this will render your icon with default colors provided by SI.
  //
  // If the colors don't look nice, or if the project is not in SI:
  // you can pass any react component!
  //
  // SVG example:
  // icon={<img style={{ height: 40, width: 40 }} src="/img/icons/parabola.svg"></img>}
  //
  // SimpleIcons "custom" component (rendering without colors):
  // icon={<SiMatrix size={40} />}
  icon={<Cpu />}
  description="ProjectABC is a..." // Short description of the project
  website="https://example.org" // Project's public website
  source="https://example.org/source" // URL to the source code repository (or a repository directory)
  license="MIT" // License under which the project is distributed
  against={["ProprietaryAlternativeA", "ProprietaryAlternativeB"]}
  // --------- Optional ---------
  // if there are blobs, include this section:
  blob="required" // 'included', 'required', or 'unknown'
  blobDescription={"Includes proprietary drivers and..."}
  // If the software is not FOSS, it has to be source-available.
  // don't forget to give us appropriate explanation as to why you still want to recommend the software!
  foss={false}

  // ratings array
  //
  // ratingType is a criteria (e.g. "Security", "Performance")
  // to compare it easily with other recommendations on the same page
  //
  // ratingValue is a score on a 0-5 scale (0.5 precision)
  //
  // ratingWhy is a simple explaination of why that score was chosen
  ratings={[
	{
	  ratingType: "Criteria 1",
	  ratingValue: 5.0,
	  ratingWhy: "Criteria 1 is the focus of this project."
	},
	{
	  ratingType: "Criteria 2",
	  ratingValue: 2.0,
	  ratingWhy: "Development lacks in Criteria 2."
	}
  ]}
/>

This example will render as:

MIT

ProjectABC is a...

Website

---

Instead of using:

• ProprietaryAlternativeA
• ProprietaryAlternativeB

---

Rating	Type	Why
	Criteria 1	Criteria 1 is the focus of this project.
	Criteria 2	Development lacks in Criteria 2.