From 17ee189db8b7d313fbad69315750c8ea66338e11 Mon Sep 17 00:00:00 2001 From: DYefremov Date: Mon, 7 Sep 2020 20:05:24 +0300 Subject: [PATCH] upd README --- README.md | 78 ++++++++++++++++++++++++++++++++----------------------- 1 file changed, 45 insertions(+), 33 deletions(-) diff --git a/README.md b/README.md index e8ea9041..60692f95 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,12 @@ # DemonEditor -[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE) -## Enigma2 channel and satellites list editor for GNU/Linux. +[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE) ![platform](https://img.shields.io/badge/platform-linux%20|%20macos-lightgrey) +### Enigma2 channel and satellites list editor for GNU/Linux. Experimental support of Neutrino-MP or others on the same basis (BPanther, etc). -Focused on the convenience of working in lists from the keyboard. The mouse is also fully supported (Drag and Drop etc) +Focused on the convenience of working in lists from the keyboard. The mouse is also fully supported (Drag and Drop etc). + +![Main app window in macOS Big Sur.](https://user-images.githubusercontent.com/7511379/92320982-9b20c780-f02e-11ea-8a43-fc0c70503573.png) -### Main features of the program: +## Main features of the program * Editing bouquets, channels, satellites. * Import function. * Backup function. @@ -13,12 +15,12 @@ Focused on the convenience of working in lists from the keyboard. The mouse is a * Downloading of picons and updating of satellites (transponders) from the web. * Import to bouquet(Neutrino WEBTV) from m3u. * Export of bouquets with IPTV services in m3u. -* Assignment of EPGs from DVB or XML for IPTV services (only Enigma2, experimental). +* Assignment of EPG from DVB or XML for IPTV services (only Enigma2, experimental). * Preview (playback) of IPTV or other streams directly from the bouquet list (should be installed [VLC](https://www.videolan.org/vlc/)). -### Keyboard shortcuts: +#### Keyboard shortcuts * **Ctrl + X** - only in bouquet list. -* **Ctrl + C** - only in services list. +* **Ctrl + C** - only in services list. Clipboard is **"rubber"**. There is an accumulation before the insertion! * **Ctrl + Insert** - copies the selected channels from the main list to the the bouquet beginning or inserts (creates) a new bouquet. @@ -30,40 +32,50 @@ Clipboard is **"rubber"**. There is an accumulation before the insertion! * **Ctrl + H** - hide/skip. * **Ctrl + P** - start play IPTV or other stream in the bouquet list. * **Ctrl + Z** - switch(**zap**) the channel(works when the HTTP API is enabled, Enigma2 only). -* **Ctrl + W** - switch to the channel and watch in the program. +* **Ctrl + W** - switch to the channel and watch in the program. * **Space** - select/deselect. * **Left/Right** - remove selection. -* **Ctrl + Up, Down, PageUp, PageDown, Home, End** - move selected items in the list. +* **Ctrl + Up, Down, PageUp, PageDown, Home, End**- move selected items in the list. * **Ctrl + O** - (re)load user data from current dir. * **Ctrl + D** - load data from receiver. -* **Ctrl + U/B** upload data/bouquets to receiver. +* **Ctrl + U/B** - upload data/bouquets to receiver. +* **Ctrl + I** - extra info, details. * **Ctrl + F** - show/hide search bar. -* **Ctrl + Shift + F** - show/hide filter bar. +* **Ctrl + Shift + F** - show/hide filter bar. + +For **multiple mouse selection** (including Drag and Drop), press and hold the **Ctrl** key! -For multiple mouse selection (including Drag and Drop), press and hold the **Ctrl** key! - -### Minimum requirements: -Python >= 3.5.2 and GTK+ >= 3.16 with PyGObject bindings, python3-requests. - -### Launching: -To start the program, in most cases it is enough to download the archive, unpack and run it by -double clicking on DemonEditor.desktop in the root directory, or launching from the console -with the command: ```./start.py``` +## Minimum requirements +*Python >= 3.5.2, GTK+ >= 3.16 with PyGObject bindings, python3-requests.* +## Installation and Launch +* ### Linux +To start the program, in most cases it is enough to download the [archive](https://github.com/DYefremov/DemonEditor/archive/master.zip), unpack and run it by +double clicking on DemonEditor.desktop in the root directory, or launching from the console +with the command: +```./start.py``` Extra folders can be deleted, excluding the *app* folder and root files like *DemonEditor.desktop* and *start.py*! - -### Note: + To create a simple **debian package**, you can use the *build-deb.sh.* -Users of **LTS** versions of [Ubuntu](https://ubuntu.com/) or those based on them can use [PPA](https://launchpad.net/~dmitriy-yefremov/+archive/ubuntu/demon-editor) repository. +Users of **LTS** versions of [Ubuntu](https://ubuntu.com/) or distributions based on them can use [PPA](https://launchpad.net/~dmitriy-yefremov/+archive/ubuntu/demon-editor) repository. +* ### macOS (experimental) +**This program can also be run on macOS.** +To work in this OS, you must use a [separate branch](https://github.com/DYefremov/DemonEditor/tree/experimental-mac). +**The functionality and performance of this version may be different from the Linux version!** + +## Important +The program is tested only with [openATV](https://www.opena.tv/) image and **Formuler F1** receiver in [Linux Mint](https://linuxmint.com/) (MATE 64-bit) distribution! -The program is tested only with [openATV](https://www.opena.tv/) image and **Formuler F1** receiver in my favourite Linux distributions -(the latest versions of [Linux Mint](https://linuxmint.com/) 18.* and 19* MATE 64-bit)! - -### Important: -Terrestrial(DVB-T/T2) and cable(DVB-C) channels are only supported for Enigma2! +Terrestrial(DVB-T/T2) and cable(DVB-C) channels are only supported for Enigma2. Main supported *lamedb* format is version **4**. Versions **3** and **5** has only **experimental** support! -For version **3** is only read mode available. When saving, version **4** format is used instead! +For version **3** is only read mode available. When saving, version **4** format is used instead. -When using the multiple import feature, from *lamedb* will be taken data **only for channels that are in the -selected bouquets!** If you need full set of the data, including *[satellites, terrestrial, cables].xml* (current files will be overwritten), -just load your data via *"File/Open"* and press *"Save"*. When importing separate bouquet files, only those services -(excluding IPTV) that are in the **current open lamedb** (main list of services) will be imported. +When using the multiple import feature, from *lamedb* will be taken data **only for channels that are in the selected bouquets!** +If you need full set of the data, including *[satellites, terrestrial, cables].xml* (current files will be overwritten), +just load your data via *"File/Open"* and press *"Save"*. When importing separate bouquet files, only those services +(excluding IPTV) that are in the **current open lamedb** (main list of services) will be imported. +#### Command line arguments: +* **-l** - write logs to file. +* **-d on/off** - turn on/off debug mode. Allows to display more information in the logs. + +## License +Licensed under the [MIT](LICENSE) license.