Change Readme from asciidoctor to markdown

1 files changed, 61 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..6a1dbf0
--- /dev/null
+++ b/README.md
@@ -0,0 +1,61 @@
+= dotfiles
+Mitsuo
+2022-08-30
+:source-highlighter: highlight.js
+
+My configuration settings and config files for various programs.
+
+
+== Usage
+
+There is an installation script but it is work in progress.  Currently it can
+only install some of the config files.
+
+
+== Description 
+
+The following applications are configured:
+
+Vim:: Nothing fancy, "the essential" and just some custom mappings
+NeoVim:: Settings, mappings, custom commands, and plugins
+Bash:: Vim input, aliases, XDG variables, git prompt
+Ideavimrc:: Some config for Vim plugin for IntelliJ and Pycharm
+Xorg:: Enviroment for Xorg.  Set fcitx env. var., start KDE Plasma
+
+// TODO: finish this list
+
+
+////
+Some files are included in the installation script 
+
+ profile                             sh config
+ bashrc                              bash "run commands"
+ bash_aliases
+ inputrc                             vim input for bash
+ vim/fun.vim                         some vim functions
+ vim/vimrc                           vim "run commands"
+ extra/newdebian                     my debian/KDE Pasma 5 conf
+ extra/qtcurvetestsettings.qtcurve     
+ extra/20-libinput.conf              enable touchpad functionality
+                                     (x220 specific)
+ 
+ git/                                Git config files
+ other/                              Other config files
+ other/ideavimrc                     ~/.ideavimrc (Pycharm)
+////
+
+
+== Installation
+
+[source, sh]
+----
+mkdir -p ~/mahcode
+git clone --recurse-submodules https://github.com/zazke/dotfiles
+cd dotfiles
+----
+
+
+== Files currently requiring manual installation
+
+*st*: For emoji support: Install https://st.suckless.org/patches/font2/[font2]
+and https://aur.archlinux.org/packages/libxft-bgra[libxft-bgra]