Arch Linux

Andy@Arch

Mitglied

in welchen Format eine Readme speichern(erledigt)

Ich hab mir eine Textdatei mit allen Shellkommandos die ich so brauche geschrieben. Soweit so gut nur in welchen Format kann ich die jetzt abspeichern, so das es immer gleich ausschaut? 
Das Problem sind wohl die Platzhalter (also Tabsprünge, mehrere Leerzeichen hintereinander und #) die Abstände sind immer unterschiedlich je nach Programm (z.B. less, Nano, Kate oder Libreoffice).

Beitrag geändert von Andy@Arch (28.06.2018 17:52:58)

stefanhusmann

Moderator

Re: in welchen Format eine Readme speichern(erledigt)

Mit Libreoffice sicherlich nicht. Ansonsten sollte das ziemlich egal sein.

niemand

Mitglied

Re: in welchen Format eine Readme speichern(erledigt)

less und nano sollten es ziemlich gleich wiedergeben, zur Sicherheit würde ich Tabs in Spaces umwandeln und Zeilenumbrüche explizit setzen. Die Darstellung von kate sollte auch nicht zu sehr abweichen, vorausgesetzt, man benutzt einen unproportionalen Font.

Die Frage ist: soll’s nur für dich sein, und ist’s dir egal, wenn man je nach Anzeigegerät kaum was erkennt, oder horizontal und vertikal scrollen muss, um alles zu erfassen, während das Layout aber in jedem Fall immer gleich bleibt? Dann PDF oder Postscript oder dvi. Oder soll’s tatsächlich eine Readme im herkömmlichen Sinn sein? Dann eindeutig Plaintext.

Beitrag geändert von niemand (27.08.2017 00:13:53)

TBone

Mitglied

Re: in welchen Format eine Readme speichern(erledigt)

zur Sicherheit würde ich Tabs in Spaces umwandeln

Bitte nicht.
https://www.startpage.com/do/search?q=i … 0alignment

Beitrag geändert von TBone (27.08.2017 01:25:21)

Andy@Arch

Mitglied

Re: in welchen Format eine Readme speichern(erledigt)

Hatte noch was drin 

<U+FEFF>#

keine Ahnung wo das her kommt........vielleicht noch von Libreoffice.

Hab es jetzt mit nano soweit editiert das es mit nano,less und more gleich aussieht.
Mit l3afpad und mousepad (beide GTK) schaut es auch gut aus sofern man die Schrift "Monospace" nimmt.
Anders sieht es mit kate, kwrite und tea (alle QT)aus, da passen die Tabs und Leerzeichen nicht.

Kann man in 'ne Textdatei eine Anweisung für den Texteditor rein packen das dieser automatisch die richtige Schriftart nimmt?

Die "Readme" soll überall mit Linux Bordmitteln funktionieren also  gleich aussehen. Egal ob eine kompletten Desktopumgebung  vorhanden ist oder ob nur Text-Konsolen-Modus  verfügbar ist. .

stefanhusmann

Moderator

Re: in welchen Format eine Readme speichern(erledigt)

zur Sicherheit würde ich Tabs in Spaces umwandeln

Bitte nicht.
https://www.startpage.com/do/search?q=i … 0alignment

Kann ich nur unterstreichen!

Z.B. in einem Makefile die Tabs durch Spaces zu ersetzen, zerstört das Makefile.
Bei Python sind die Einrückungen signifikant, darüber wird der Quelltext geparst.

In einem README, um das es hier ja geht, besteht diese Gefahr allerdings nicht.

Kann man in 'ne Textdatei eine Anweisung für den Texteditor rein packen das dieser automatisch die richtige Schriftart nimmt?

Möglicherweise kann man das, aber ws soll das bringen? Wer soll das README lesen? Wenn es jemand anders als du selbst bist, kannst du nicht davon ausgehen, dass er/sie denselben Texteditor benutzt wie du. Und außerdem kann es ja durchaus unterschiedliche Schriftarten geben die gleichermaßen "richtig" sind.

Aber du kannst deinem Texteditor sagen, dass er eine dicktengleiche Schrift zur Darstellung nehmen soll, oder einen im Terminal laufenden Editor nehmen, der dann die hoffentlich dicktengleiche Schriftart vom Terminal übrnimmt.

Die "Readme" soll überall mit Linux Bordmitteln funktionieren also  gleich aussehen. Egal ob eine kompletten Desktopumgebung  vorhanden ist oder ob nur Text-Konsolen-Modus  verfügbar ist. .

Also kein pdf.

niemand

Mitglied

Re: in welchen Format eine Readme speichern(erledigt)

Bitte nicht.

Wie stefanhusman schon schrieb: es geht um Readme, nicht um Scripte oder Makefiles (wenngleich ich in Erinnerung habe, das PEP8 empfiehlt, Spaces statt Tabs zu verwenden – und zwar derer vier für einen Druck auf die Tab-Taste). Einige Viewer und Editoren zeigen Tabs halt nicht an, während Spaces fast immer angezeigt werden.

Die "Readme" soll überall mit Linux Bordmitteln funktionieren also  gleich aussehen. Egal ob eine kompletten Desktopumgebung  vorhanden ist oder ob nur Text-Konsolen-Modus  verfügbar ist.

Also kein pdf.

Stimmt, den Teil habe ich überlesen gab’s zum Zeitpunkt meines Beitrags noch nicht. Dann bleibt ja eh nur noch plain ASCII txt, ohne jegliche Steuerzeichen oder Fontvorgaben – von allem anderen kann man nicht davon ausgehen, dass es überall zur Verfügung steht und auf gleiche Weise dargestellt wird.

Beitrag geändert von niemand (27.08.2017 11:18:09)

Andy@Arch

Mitglied

Re: in welchen Format eine Readme speichern(erledigt)

Es liegt wohl an den Tabulatoren, bei GTK-Text-Editoren und in der Shell sind diese (anscheinend) auf 8 Leerzeichen eingestellt.
Bei QT-Text-Editoren sind sie (anscheinend) standardmäßig auf 4 Leerzeichen eingestellt, stellt man dies auf 8 Leerzeichen um und nimmt noch irgend eine Mono-Schriftart passt es.
Muss man erst mal drauf kommen, dachte Tabulator ist überall gleich.

TBone

Mitglied

Re: in welchen Format eine Readme speichern(erledigt)

Bitte nicht.

Wie stefanhusman schon schrieb: es geht um Readme, nicht um Scripte oder Makefiles

Fr mich hört sich das, was der TE sagt, aber eher nach Skripten an.

Ich hab mir eine Textdatei mit allen Shellkommandos die ich so brauche geschrieben.

Shellkommandos, Skripte.
Wären es Ein-Zeiler, hätte er wohl keine Einrückungen.

niemand

Mitglied

Re: in welchen Format eine Readme speichern(erledigt)

Für mich hört’s sich eher nach einer Datei zum Nachgucken besagter Shellbefehle an. Eine Readme ist traditionell eine Textdatei, kein Script.

sanni

Mitglied

Re: in welchen Format eine Readme speichern(erledigt)

Ich habe auch so eine Textdatei.  Da sind Kommandos drin, die ich nur hin und wieder mal brauche und gerne vergesse.
Suchen macht mir keinen Spass, auch wenn das hier ein wunderbares Forum/Wiki ist.

TBone

Mitglied

Re: in welchen Format eine Readme speichern(erledigt)

Für mich hört’s sich eher nach einer Datei zum Nachgucken besagter Shellbefehle an. Eine Readme ist traditionell eine Textdatei, kein Script.

Sowas hat allerdings auch noch niemanden davon abgehalten, etwas zu tun.