Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
FrancescoCeruti committed Dec 10, 2023
1 parent ffe91c8 commit 6a9ca35
Showing 1 changed file with 16 additions and 13 deletions.
29 changes: 16 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,44 +8,47 @@
<a href="https://github.com/FrancescoCeruti/linux-show-player/blob/master/LICENSE"><img alt="License: GPL" src="https://img.shields.io/badge/license-GPL-blue.svg"></a>
<a href="https://github.com/FrancescoCeruti/linux-show-player/releases/latest"><img src="https://img.shields.io/github/release/FrancescoCeruti/linux-show-player.svg?maxAge=2592000" alt="GitHub release" /></a>
<a href="https://github.com/FrancescoCeruti/linux-show-player/releases"><img src="https://img.shields.io/github/downloads/FrancescoCeruti/linux-show-player/total.svg?maxAge=2592000" alt="Github All Releases" /></a>
<a href="https://www.codacy.com/app/ceppofrancy/linux-show-player?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=FrancescoCeruti/linux-show-player&amp;utm_campaign=Badge_Grade"><img src="https://api.codacy.com/project/badge/Grade/bef08c3ae14e4953962b7e4bc82a0c03" alt="Code Health" /></a>
<a href="https://sonarcloud.io/summary/new_code?id=FrancescoCeruti_linux-show-player"><img src="https://sonarcloud.io/api/project_badges/measure?project=FrancescoCeruti_linux-show-player&metric=alert_status" alt="Quality Gate Status"></a>
<a href="https://gitter.im/linux-show-player/linux-show-player"><img src="https://img.shields.io/gitter/room/nwjs/nw.js.svg?maxAge=2592000" alt="Gitter" /></a>
<a href="https://github.com/ambv/black"><img src="https://img.shields.io/badge/code%20style-black-000000.svg" alt="Code style: black"></a>
</p>

---

Linux Show Player, LiSP for short, is a free cue player, primarily intended for sound-playback during stage productions. The ultimate goal is to provide a complete playback software for musical plays, theatre shows, and similar.
Linux Show Player, LiSP for short, is a free cue player, primarily intended for sound-playback during stage productions.
The ultimate goal is to provide a complete playback software for musical plays, theatre shows, and similar.

For bugs and requests you can open an issue on the GitHub issues tracker; for support, discussions, and anything else you should use the [gitter](https://gitter.im/linux-show-player/linux-show-player) chat.
For bugs and requests you can open an issue on the GitHub issues tracker; for support, discussions, and anything else
you should use the [discussion](https://github.com/FrancescoCeruti/linux-show-player/discussions) section on GitHub
or the [gitter/matrix](https://gitter.im/linux-show-player/linux-show-player) chat.

---
Linux Show Player is currently developed and tested for **GNU/Linux** only.<br>
_The core components (Python, GStreamer and Qt) are multi-platform, thus in future - despite the name - LiSP might get ported to other platforms._

### Installation
---

Linux Show Player is currently developed on and tested for **GNU/Linux** only.<br>
_The core components (Python3, GStreamer and Qt5) are multi-platform, thus in future - despite the name - LiSP might get ported to other platforms._
## 🧑‍💻 Installation

#### 📦 Flatpak
You can find the full instructions in the <a href="https://linux-show-player-users.readthedocs.io/en/latest/installation.html">user manual</a>.

From version _0.6_ it will be possible to install a [Flatpak](https://flatpak.org/) package, follow the _simple_ instructions on their website to get everything ready.
### 📦 Flatpak

You can get the latest **development** builds here:
* [Master](https://github.com/FrancescoCeruti/linux-show-player/releases/tag/ci-master) - Generally stable
* [Development](https://github.com/FrancescoCeruti/linux-show-player/releases/tag/ci-develop) - Preview features, might be unstable and untested

#### 🐧 From your distribution repository
### 🐧 From your distribution repository

For some GNU/Linux distributions you can install a native package.<br>
Keeping in mind that it might not be the latest version, you can find a list on [repology.org](https://repology.org/metapackage/linux-show-player).

---

### 📖 Usage
## 📖 Usage

A user manual can be [viewed online](http://linux-show-player-users.readthedocs.io/en/latest/index.html) or downloaded from the [releases page](https://github.com/FrancescoCeruti/linux-show-player/releases) on GitHub.
The user manual can be [viewed online](http://linux-show-player-users.readthedocs.io/en/latest/index.html)

#### ⌨️ Command line:
### ⌨️ Command line:

```
usage: linux-show-player [-h] [-f [FILE]] [-l {debug,info,warning}]
Expand Down

0 comments on commit 6a9ca35

Please sign in to comment.