Skip to content

improve README structure and installation instructions#6988

Merged
vitormattos merged 11 commits intoLibreSign:mainfrom
yharroch:yharroch-patch-1
Apr 28, 2026
Merged

improve README structure and installation instructions#6988
vitormattos merged 11 commits intoLibreSign:mainfrom
yharroch:yharroch-patch-1

Conversation

@yharroch
Copy link
Copy Markdown
Contributor

  • Add Quick Links and improve section structure
  • Document occ libresign:install and libresign:configure:* usage
  • Clarify standalone dependencies in appdata directory
  • Improve license and security references

- Add Quick Links and improve section structure
- Document occ libresign:install and libresign:configure:* usage
- Clarify standalone dependencies in appdata directory
- Improve license and security references

Signed-off-by: yharroch <82467465+yharroch@users.noreply.github.com>
@github-project-automation github-project-automation Bot moved this to 0. Needs triage in Roadmap Feb 21, 2026
Copy link
Copy Markdown
Member

@vitormattos vitormattos left a comment

Choose a reason for hiding this comment

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

This is great! The README needed some love. Thanks for taking the initiative.

I feel that some parts read more like full documentation than a README, and a bit too detailed for this level. Maybe we can keep it more focused on what LibreSign is and its core principles, and move deeper explanations to the documentation repository.

I’ve added a few suggestions in the PR to start the review and show the direction I’m thinking about. Happy to iterate together.

Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
@github-project-automation github-project-automation Bot moved this from 0. Needs triage to 1. to do in Roadmap Feb 21, 2026
@yharroch
Copy link
Copy Markdown
Contributor Author

Thanks for your feedback. I’m happy to help and iterate further.
Please don’t hesitate to be direct — I’m new to GitHub, and I don’t mind if some of my suggestions don’t fit.
I tried to include as much information as possible, even if some of it ends up being moved to another section or discarded.

Co-authored-by: Vitor Mattos <vitor@php.rio>
Signed-off-by: yharroch <82467465+yharroch@users.noreply.github.com>
@vitormattos
Copy link
Copy Markdown
Member

@yharroch, you can ask about any doubts in the comments regarding what I discussed that you didn’t understand.

yharroch and others added 6 commits February 26, 2026 14:18
deletion of useless technical information

Co-authored-by: Vitor Mattos <vitor@php.rio>
Signed-off-by: yharroch <82467465+yharroch@users.noreply.github.com>
update link's title for contribution

Co-authored-by: Vitor Mattos <vitor@php.rio>
Signed-off-by: yharroch <82467465+yharroch@users.noreply.github.com>
Deletion of useless license's section

Co-authored-by: Vitor Mattos <vitor@php.rio>
Signed-off-by: yharroch <82467465+yharroch@users.noreply.github.com>
deletion of useless line

Co-authored-by: Vitor Mattos <vitor@php.rio>
Signed-off-by: yharroch <82467465+yharroch@users.noreply.github.com>
Adding application's descriptions about some features

Co-authored-by: Vitor Mattos <vitor@php.rio>
Signed-off-by: yharroch <82467465+yharroch@users.noreply.github.com>
fixing link

Co-authored-by: Vitor Mattos <vitor@php.rio>
Signed-off-by: yharroch <82467465+yharroch@users.noreply.github.com>
@yharroch
Copy link
Copy Markdown
Contributor Author

Hi @vitormattos
I tried to resolve and merge your suggestions but i'm stuck at what's next.
Do I commit again ?
Do I need to do something specific ?

I'll tried to work again on the documentation in the right repository during next weeks

@vitormattos
Copy link
Copy Markdown
Member

Hi, I will review again the newest version.

Copy link
Copy Markdown
Member

@vitormattos vitormattos left a comment

Choose a reason for hiding this comment

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

I made some more comments after last changes. Could you join into a new turn and check again? What do you think about the direction that we are going now with last changes?

Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
Signed-off-by: Vitor Mattos <1079143+vitormattos@users.noreply.github.com>
@vitormattos
Copy link
Copy Markdown
Member

/backport to stable33

@vitormattos
Copy link
Copy Markdown
Member

/backport to stable32

Signed-off-by: Vitor Mattos <1079143+vitormattos@users.noreply.github.com>
Signed-off-by: Vitor Mattos <1079143+vitormattos@users.noreply.github.com>
@vitormattos vitormattos merged commit 4a3a0b6 into LibreSign:main Apr 28, 2026
3 checks passed
@github-project-automation github-project-automation Bot moved this from 1. to do to 4. to release in Roadmap Apr 28, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: 4. to release

Development

Successfully merging this pull request may close these issues.

2 participants