Skip to content

Conversation

@davidandrewthompson
Copy link

Hello All. I hope you don't mind, but I decided to revamp the README.md. After trying to use git-crypt (which is a great product, and thank you!), I found that I had a difficult time understanding the documentation as it was written.

I changed the layout and edited the copy (wording). I also added a logo to give it a nice look.

Please feel free to use or not use whatever you like. I did this because I appreciate the hard work that you (all) put into this project. I'm already using it in a few projects and being a writer/editor, I felt like giving back from my particular skill sets.

If there's anything you might like me to change, or if there is some other way I can help, please let me know.

Thanks again!

Copy link

@jarsi jarsi left a comment

Choose a reason for hiding this comment

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

Hi, I recently started using git-crypt and am very happy with how it works. Thanks a lot! I agree with your suggestion to revamp the README. I think it looks awesome, but I found an inconsistency in the installation instructions. Depending on the OS, a package manager other than apt is used. I suggest to either state, that depending on the used OS, the user should check the repositoriy or explicitly provide the installation commands for each OS.

Comment on lines +26 to +28
1. For ***nix** based systems.

apt-get install git-crypt
Copy link

Choose a reason for hiding this comment

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

apt is the package manager in debian based distributions, thus sudo apt-get install git-crypt will only work for these distributions. Other operating systems, such as Fedora, Arch, Gentoo, FreeBSD,... have their own package managers. I checked the package repositories for some of the other OSs and most, if not all, provide git-crypt (But via different commands due to different package managers).

@tomerh2001
Copy link

+1
I think this should be merged, for such an helpful project, the readme needs an update

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants