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

doc: add INSTALL.md #857

Merged
merged 4 commits into from
Nov 15, 2021
Merged

doc: add INSTALL.md #857

merged 4 commits into from
Nov 15, 2021

Conversation

jaeheonji
Copy link
Member

A lot of people love Zellij ❤️

Currently, people who like zellij are managing it through various package managers.
So I've put together the documentation to make it easily accessible to a variety of people.

There is still little content, but I believe this will grow over time.

@imsnif
Copy link
Member

imsnif commented Nov 10, 2021

Hey, this is great! Just a small request, can you add something like: "These packages are not affiliated with the Zellij maintainers and are provided here for convenience" somewhere near the top?

@jaeheonji
Copy link
Member Author

jaeheonji commented Nov 11, 2021

@imsnif Yes! you're right :) I added that phrase to the top of packages section.

@a-kenji
Copy link
Contributor

a-kenji commented Nov 11, 2021

@jaeheonji
We have an installation guide at:
https://zellij.dev/documentation/installation.html
do you think it would make sense move them together?

Maybe the one from the documentation here,
or the one from here to the documentation?
And we could link to them?

@jaeheonji
Copy link
Member Author

@a-kenji
Oh... sorry! I didn't consider its existence. then, I have an idea.

  • First, rollback README.md and add link to THIRD_PARTY_INSTALL.md (need to create)
  • THIRD_PARTY_INSTALL.md includes pacakging status and installation method using each package manager.
  • And add link to THIRD_PARTY_INSTALL.md in this section

This will make it easier for people to contribute (added more package installation methods).
And contributors also seem to have easy document management.

How about this option?

@a-kenji
Copy link
Contributor

a-kenji commented Nov 11, 2021

@jaeheonji
No problem. I just want it to be in one place.
I like your suggestion!

@jaeheonji
Copy link
Member Author

jaeheonji commented Nov 15, 2021

I updated the README content :)

Copy link
Contributor

@a-kenji a-kenji left a comment

Choose a reason for hiding this comment

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

Thanks, looks good!

@a-kenji a-kenji merged commit c35a6ba into zellij-org:main Nov 15, 2021
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.

3 participants