diff --git a/README.md b/README.md index 5da0c6cc..1c3020a9 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,13 @@ # DemonEditor -[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE) -## Enigma2 channel and satellites list editor for macOS (experimental). -### The functionality and performance of this version may be different from the Linux version! +[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE) ![platform](https://img.shields.io/badge/platform-macos-lightgrey) +## Enigma2 channel and satellites list editor for macOS (experimental). +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). +**The functionality and performance of this version may be different from the [Linux version](https://github.com/DYefremov/DemonEditor)!** -### Main features of the program: +![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 * Editing bouquets, channels, satellites. * Import function. * Backup function. @@ -14,7 +18,7 @@ * Export of bouquets with IPTV services in m3u. * Assignment of EPGs 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 * **⌘ + X** - only in bouquet list. * **⌘ + C** - only in services list. Clipboard is **"rubber"**. There is an accumulation before the insertion! @@ -36,38 +40,54 @@ Clipboard is **"rubber"**. There is an accumulation before the insertion! For multiple mouse selection (including Drag and Drop), press and hold the **⌘** key! -### Minimum requirements: -Python >= **3.5**, GTK+ >= **3.16**, pygobject3, adwaita-icon-theme, python3-requests. -### Installation: +## Minimum requirements +*Python >= 3.5.2, GTK+ >= 3.16 with PyGObject bindings, python3-requests.* + +## Installation and Launch +To run the program on macOS, you need to install [brew](https://brew.sh/). +Then install the required components via terminal: ```brew install python3 gtk+3 pygobject3 adwaita-icon-theme``` ```pip3 install requests``` -### Optional: +#### Optional: ```brew install wget``` -```pip3 install pillow, pyobjc``` -### Launching: -To start the program, just download the archive, unpack and run it from the terminal with the command: ```./start.py``` -### Building standalone application: -Install [PyInstaller](https://www.pyinstaller.org/) with the command from the terminal: -```pip3 install pyinstaller``` -and in th root dir run command: -```pyinstaller DemonEditor.spec``` -### Standalone package: -You can download the ready-made package as a ***.dmg** file from the [releases](https://github.com/DYefremov/DemonEditor/releases) page. +```pip3 install pillow, pyobjc``` + +To start the program, just download the [archive](https://github.com/DYefremov/DemonEditor/archive/experimental-mac.zip), unpack and run it from the terminal +with the command: ```./start.py``` +## Standalone package +You can also download the ready-made package as a ***.dmg** file from the [releases](https://github.com/DYefremov/DemonEditor/releases) page. Recommended copy the package to the **Application** directory. Perhaps in the security settings it will be necessary to allow the launch of this application! **The package may not contain all the latest changes. Not all features can be supported and tested!** -### Note: + THIS SOFTWARE COMES WITH ABSOLUTELY NO WARRANTY. AUTHOR IS NOT LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY CONNECTION WITH THIS SOFTWARE. The package may contain components distributed under the GPL [v3](http://www.gnu.org/licenses/gpl-3.0.html) or lower license. -By downloading and using this package you agree to the terms of this [license](http://www.gnu.org/licenses/gpl-3.0.html) and the possible inconvenience associated with this! - -### Important: -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! +By downloading and using this package you agree to the terms of this [license](http://www.gnu.org/licenses/gpl-3.0.html) and the possible inconvenience associated with this! -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. +#### Building your own package +Install [PyInstaller](https://www.pyinstaller.org/) with the command from the terminal: + +```pip3 install pyinstaller``` + +and in the root dir run command: + +```pyinstaller DemonEditor.spec``` +## Important +**This version is not fully tested and has experimental status!** + +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. + +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. +* **-t on/off** - show/hide simple built-in **telnet** client (experimental). **ANSI escape sequences are not supported!** + +## License +Licensed under the [MIT](LICENSE) license.