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

Update README.md #2825

Merged
merged 3 commits into from
Dec 21, 2024
Merged

Update README.md #2825

merged 3 commits into from
Dec 21, 2024

Conversation

tinohager
Copy link
Contributor

This pull request includes significant updates to the README.md file to enhance clarity, improve structure.

Enhancements to the README.md:

  • Rewritten introduction to provide a clearer and more engaging description of Lychee, including a mention of the Supporter Edition.
  • Reorganized installation instructions into three clear deployment options: file-based, Docker, and build from source.
  • Moved and updated the notice about the master and alpha branches to provide better context on the development process and encourage contributions.

README.md Outdated
Comment on lines 42 to 44
### Docker deployment

Alternatively, an official Docker image can be found at [LycheeOrg/Lychee-Docker](https://github.com/LycheeOrg/Lychee-Docker) or on Docker Hub as [lycheeorg/lychee](https://hub.docker.com/r/lycheeorg/lychee).
Copy link
Contributor

Choose a reason for hiding this comment

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

This should probably be above File-based if we're recommending it.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

File-based has the disadvantage that many dependencies such as ffmpeg or the php version must fit. This catalog of dependencies does not exist with docker and the installation of the lychee docker variant requires 3 commandos. So maybe the way should point in that direction it is definitely the way I would recommend to install it today.

Copy link
Contributor

Choose a reason for hiding this comment

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

Agreed, it just feels weird saying "We recommend using Docker, but first, here's how to do it a different way" :)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I turned it

README.md Outdated Show resolved Hide resolved
Co-authored-by: Martin Stone <[email protected]>
@ildyria ildyria merged commit 58eff87 into LycheeOrg:master Dec 21, 2024
3 checks passed
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