From 43ad516e5e45981f4bf802bfc7083d0b7885cd8d Mon Sep 17 00:00:00 2001 From: Claudius Ellsel Date: Thu, 18 Jun 2020 16:03:19 +0000 Subject: [PATCH] Use markdown syntax in README Change dir structure to use a table Also minor formatting changes --- README | 44 -------------------------------------------- README.md | 28 ++++++++++++++++++++++++++++ 2 files changed, 28 insertions(+), 44 deletions(-) delete mode 100644 README create mode 100644 README.md diff --git a/README b/README deleted file mode 100644 index 3ae574358..000000000 --- a/README +++ /dev/null @@ -1,44 +0,0 @@ -Konsole - KDE's Terminal Emulator -================================== - -Konsole is a terminal program for KDE. - -As well as being a standalone program, it is also used by other KDE programs -such as the Kate editor and KDevelop development environment to provide easy -access to a terminal window. Konsole's features and usage are explained and -illustrated in the Konsole handbook, which can be accessed by browsing to -"help:/konsole" in Konqueror. - - -Directory Structure -=================== - - /doc/user README files, primarily for advanced users, explaining various - aspects of Konsole such as fonts and keyboard handling - in-depth. - - /doc/developer README files and resources for developers of Konsole. This - includes information on the design of Konsole's internals and - the VT100 terminal on which Konsole's emulation is based. - - /src Source code for Konsole, including the embedded versions of - Konsole which are used in Kate, KDevelop and others. - - /desktop .desktop files for Konsole, used to launch the program - from KDE's various menus and other application launchers. - - /data Data files for use with Konsole as well as the keyboard setup - and color schemes provided with Konsole. - - -Contact -======= - -Up-to-date information about the latest releases can be found on Konsole's -website at http://konsole.kde.org. Discussions about Konsole's development are -held on the konsole-devel mailing list, which can be accessed at -https://mail.kde.org/mailman/listinfo/konsole-devel. - - -Share and enjoy it, - Lars diff --git a/README.md b/README.md new file mode 100644 index 000000000..a0f6af930 --- /dev/null +++ b/README.md @@ -0,0 +1,28 @@ +# Konsole - KDE's Terminal Emulator + +Konsole is a terminal program for KDE. + +As well as being a standalone program, it is also used by other KDE programs +such as the Kate editor and KDevelop development environment to provide easy +access to a terminal window. Konsole's features and usage are explained and +illustrated in the Konsole handbook, which can be accessed by browsing to +`help:/konsole` in Konqueror. + + +## Directory Structure + +| Directory | Description | +| ------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `/doc/user` | README files, primarily for advanced users, explaining various aspects of Konsole such as fonts and keyboard handling in-depth. | +| `/doc/developer` | README files and resources for developers of Konsole. This includes information on the design of Konsole's internals and the VT100 terminal on which Konsole's emulation is based. | +| `/src` | Source code for Konsole, including the embedded versions of Konsole which are used in Kate, KDevelop and others. | +| `/desktop` | .desktop files for Konsole, used to launch the program from KDE's various menus and other application launchers. | +| `/data` | Data files for use with Konsole as well as the keyboard setup and color schemes provided with Konsole. | + + +## Contact + +Up-to-date information about the latest releases can be found on Konsole's +website at http://konsole.kde.org. Discussions about Konsole's development are +held on the konsole-devel mailing list, which can be accessed at +https://mail.kde.org/mailman/listinfo/konsole-devel. \ No newline at end of file