Merge pull request #11 from ypid/fix-readme

Convert README.md to gfm
This commit is contained in:
Olaf S 2020-05-24 00:15:55 +02:00 committed by GitHub
commit c22502f7b4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 7 deletions

View File

@ -2,11 +2,11 @@ Beschreibung
======================================================================== ========================================================================
Der NeoLayoutViewer bietet eine einfache Möglichkeit, das NEO2- Der NeoLayoutViewer bietet eine einfache Möglichkeit, das NEO2-
Tastaturlayout¹ auf dem Bildschirm anzuzeigen. Tastaturlayout¹ auf dem Bildschirm anzuzeigen.
Das Programmfenster besteht nur aus dem Bild einer der sechs Ebenen des Layouts. Das Programmfenster besteht nur aus dem Bild einer der sechs Ebenen des Layouts.
Wird eine der Mod-Tasten (Shift,…) gedrückt oder losgelassen, wechselt die Anzeige zur zugehörigen Wird eine der Mod-Tasten (Shift,…) gedrückt oder losgelassen, wechselt die Anzeige zur zugehörigen
Ebene. Außerdem kann das Fenster per Tastenkombination bewegt oder ausgeblendet werden. Ebene. Außerdem kann das Fenster per Tastenkombination bewegt oder ausgeblendet werden.
Alle Einstellungen können über eine Konfigurationsdatei angepasst werden. Alle Einstellungen können über eine Konfigurationsdatei angepasst werden.
Autoren: Olaf Schulz 2011-2019, rixx 2013, Marco Herrn 2018-2019 Autoren: Olaf Schulz 2011-2019, rixx 2013, Marco Herrn 2018-2019
@ -23,7 +23,7 @@ und die Developer-Pakete einiger Bibliotheken. Die Abhängigkeiten können unter
mit dem folgenden Befehl nachinstalliert werden, sofern sie nicht bereits vorhanden sind mit dem folgenden Befehl nachinstalliert werden, sofern sie nicht bereits vorhanden sind
(Stand: Ubuntu 16.04, November 2017). Bei anderen Distributionen muss der Befehl ggf. angepasst werden. (Stand: Ubuntu 16.04, November 2017). Bei anderen Distributionen muss der Befehl ggf. angepasst werden.
sudo apt-get install valac libgee-0.8-dev libgtk-3-dev libx11-dev libappindicator3-dev sudo apt install valac libgee-0.8-dev libgtk-3-dev libx11-dev libappindicator3-dev
Mittels Mittels
@ -36,11 +36,13 @@ Geben Sie in diesem Falle „ICON=tray make“ ein.
Hinweise Hinweise
======================================================================== ========================================================================
• Beim ersten Start wird die Datei $HOME/.config/neo_layout_viewer.conf
* Beim ersten Start wird die Datei $HOME/.config/neo_layout_viewer.conf
erstellt. (Sollte die Datei in diesem Verzeichnis nicht angelegt werden können, erstellt. (Sollte die Datei in diesem Verzeichnis nicht angelegt werden können,
wird als Speicherort $HOME und das derzeitge Verzeichnis ausprobiert.) wird als Speicherort $HOME und das derzeitge Verzeichnis ausprobiert.)
In der Konfigurationsdatei können unter anderem folgende Einstellungen vorgenommen In der Konfigurationsdatei können unter anderem folgende Einstellungen vorgenommen
werden: werden:
- Breite des Fensters. Mit „width“ können Sie die exakte Breite einstellen und mit - Breite des Fensters. Mit „width“ können Sie die exakte Breite einstellen und mit
„max_width“ und „min_width“ die relative Breite in Bezug auf die derzeitige Auflösung. „max_width“ und „min_width“ die relative Breite in Bezug auf die derzeitige Auflösung.
- Anzeige des Numblocks und der Funktionstasten. - Anzeige des Numblocks und der Funktionstasten.
@ -52,17 +54,18 @@ Hinweise
Der Wert X∈{1,…,9} ist entsprechend der Position auf dem Numblocks zu interpretieren. Der Wert X∈{1,…,9} ist entsprechend der Position auf dem Numblocks zu interpretieren.
Beim Druck der Tastenkombination springt das Fenster von Position X zu position_cycle[X]. Beim Druck der Tastenkombination springt das Fenster von Position X zu position_cycle[X].
Das Programm kann auch als virtuelle Tastatur genutzt werden. Damit die Eingabe das * Das Programm kann auch als virtuelle Tastatur genutzt werden. Damit die Eingabe das
richtige Fenster erreicht muss in der Konfigurationsdatei „window_selectable = 0“ richtige Fenster erreicht muss in der Konfigurationsdatei „window_selectable = 0“
eingetragen werden. eingetragen werden.
Das Programm zeigt unter Gnome 3.x in der Indicator-Leiste ein Symbol an. Unter Gnome 2.x * Das Programm zeigt unter Gnome 3.x in der Indicator-Leiste ein Symbol an. Unter Gnome 2.x
war für diese Funktion noch eine andere Bibliothek verantwortlich. Sie können im war für diese Funktion noch eine andere Bibliothek verantwortlich. Sie können im
Makefile zwischen den beiden Varianten wechseln, indem Sie die Variable ICON anpassen. Makefile zwischen den beiden Varianten wechseln, indem Sie die Variable ICON anpassen.
______________________________________________________________________ ______________________________________________________________________
¹NEO ist eine Tastaturbelegung, welche für die deutsche Sprache optimiert ist. ¹NEO ist eine Tastaturbelegung, welche für die deutsche Sprache optimiert ist.
Die offizielle Seite des Projektes: http://neo-layout.org/ Die offizielle Seite des Projektes: https://neo-layout.org/