From 6497a32bc69f71b03db4ef86a83fe7175c3b4bae Mon Sep 17 00:00:00 2001 From: Bart Lauret Date: Mon, 1 Apr 2024 11:43:02 +0200 Subject: [PATCH] Fancy README.md like all the cool kids do nowadays --- README.md | 78 +++++++++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 76 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index d86df184c1..9ae858b8d6 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,38 @@ -Lyrion Music Server -==== + + +[![Build passing][build-shield]][build-url] +[![Perl][Perl]][Perl-url] +[![Contributors][contributors-shield]][contributors-url] +[![Forks][forks-shield]][forks-url] +[![Stargazers][stars-shield]][stars-url] +[![Issues][issues-shield]][issues-url] +[![Pull requests][pulls-shield]][pulls-url] +[![Docker pulls][docker-pulls-shield]][docker-pulls-url] + +
+
+ + Logo + + +

Lyrion Music Server

+ +

+ Streaming audio server +
+ Explore the docs » +
+
+ Report Bug + · + Request Feature +

+ +
+ +## About The Project + +[![LMS Screen Shot][lyrion-screenshot]](https://lyrion.org) Lyrion Music Server (aka. LMS, fka. Logitech Mediaserver, SlimServer, SqueezeCenter, SqueezeboxServer, SliMP3) is the server software that powers audio players from [Logitech](https://www.logi.com) (formerly known as SlimDevices), including [Squeezebox 3rd Generation, Squeezebox Boom, Squeezebox Receiver, Transporter, Squeezebox2, Squeezebox and SLIMP3](https://lms-community.github.io/players-and-controllers/hardware-comparison/), and many software emulators like [Squeezelite and SqueezePlay](https://sourceforge.net/projects/lmsclients/files/). @@ -8,3 +41,44 @@ With the help of many plugins, Lyrion Music Server can stream not only your loca Lyrion Music Server is written in Perl. It runs on pretty much any platform that Perl runs on, including Linux, Mac OSX, Solaris and Windows. Enjoy the music on your Squeezebox! + +

(back to top)

+ +## Getting Started + +LMS runs on almost anything! Whether you have a Windows, macOS or Linux system, whether this is a single board computer (such as a Raspberry Pi), desktop, laptop or even a NAS, LMS will most likely run on it. Go to the [Getting started documentation](https://lyrion.org/getting-started/) for installation instructions. + +

(back to top)

+ +## Contributing + +Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**. + +If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". +Don't forget to give the project a star! Thanks again! + +1. Fork the Project +2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`) +3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`) +4. Push to the Branch (`git push origin feature/AmazingFeature`) +5. Open a Pull Request + +

(back to top)

+ +[build-shield]: https://img.shields.io/github/actions/workflow/status/LMS-Community/slimserver/00_smoketest.yaml?style=flat +[build-url]: https://github.com/LMS-Community/slimserver/actions/workflows/00_smoketest.yaml +[contributors-shield]: https://img.shields.io/github/contributors/LMS-Community/slimserver.svg?style=flat +[contributors-url]: https://github.com/LMS-Community/slimserver/graphs/contributors +[forks-shield]: https://img.shields.io/github/forks/LMS-Community/slimserver.svg?style=flat +[forks-url]: https://github.com/LMS-Community/slimserver/network/members +[stars-shield]: https://img.shields.io/github/stars/LMS-Community/slimserver.svg?style=flat +[stars-url]: https://github.com/LMS-Community/slimserver/stargazers +[issues-shield]: https://img.shields.io/github/issues/LMS-Community/slimserver.svg?style=flat +[issues-url]: https://github.com/LMS-Community/slimserver/issues +[pulls-shield]: https://img.shields.io/github/issues-pr/LMS-Community/slimserver.svg?style=flat +[pulls-url]: https://github.com/LMS-Community/slimserver/pulls +[docker-pulls-shield]: https://img.shields.io/docker/pulls/lmscommunity/logitechmediaserver?style=flat +[docker-pulls-url]: https://hub.docker.com/r/lmscommunity/logitechmediaserver +[lyrion-screenshot]: https://raw.githubusercontent.com/LMS-Community/lms-community.github.io/main/docs/reference/assets/winscp/9-winscp.png +[Perl]: https://img.shields.io/badge/Written_in-perl-orange?logo=perl +[Perl-url]: https://perl.org/