Skip to content
This repository was archived by the owner on Jun 24, 2025. It is now read-only.

Reorganize + rewrite readme, reducing redundancy - #1976

Merged
eliandoran merged 1 commit into
TriliumNext:developfrom
FliegendeWurst:readme-rewrite
May 20, 2025
Merged

Reorganize + rewrite readme, reducing redundancy#1976
eliandoran merged 1 commit into
TriliumNext:developfrom
FliegendeWurst:readme-rewrite

Conversation

@FliegendeWurst

Copy link
Copy Markdown
Member

Addresses TriliumNext/Trilium#5703

Changes done:

  1. Moved "Features" block up. Newcomers are probably most interested in this section.
  2. Added several of TriliumNext's new features to the features section.
  3. Reorganized installation instructions. Note: the included repology table will list two more distributions (AUR, Scoop) soon.
  4. Added copyright line (in License section). Specifying a license also requires specifying the authors, I think.
  5. Mention both "free" and "open-source". Some people care deeply about this. (Suggested reading.)
  6. Other small changes for consistency

If you want, you can also pick up only some parts of this PR

@SiriusXT

Copy link
Copy Markdown
Member

And the upcoming AI integration.

@FliegendeWurst

Copy link
Copy Markdown
Member Author

Please suggest a line :) I'm not familiar with the integration yet.

@SiriusXT

Copy link
Copy Markdown
Member

Please suggest a line :) I'm not familiar with the integration yet.

I'm not yet familiar with the details of the AI feature either and will need @perfectra1n 's help.

@perfectra1n

Copy link
Copy Markdown
Member

I can add that to the README later, don’t worry about it for now :)

Comment thread README.md Outdated

Until we finish reorganizing the documentation, you may also want to [browse the old documentation](https://triliumnext.github.io/Docs).

In particular, [patterns of personal knowledge base](https://triliumnext.github.io/Docs/Wiki/patterns-of-personal-knowledge) may give some inspiration on how to use TriliumNext effectively.

@perfectra1n perfectra1n May 20, 2025

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Maybe we could bump this up into the unordered list above (line 67 in particular)

@perfectra1n

Copy link
Copy Markdown
Member

Really my only nit though, I like the new order of it. Thanks!

@eliandoran
eliandoran merged commit ff6630f into TriliumNext:develop May 20, 2025
@eliandoran eliandoran added this to the v0.94.0 milestone May 20, 2025
@perfectra1n

Copy link
Copy Markdown
Member

Also updated our DockerHub README with this updated version @eliandoran.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants