summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorMitsuo Tokumori <[email protected]>2023-10-10 17:50:01 -0500
committerMitsuo Tokumori <[email protected]>2023-10-10 17:50:01 -0500
commit2756d3189374174f1e07a6df0f47d679fdc6e791 (patch)
tree073ae21bb698927087b36ae0e3286ee2a7a0214b /README.md
parent6b6717f132f94cb64d5a54bd11e906cc96c8c29c (diff)
downloaddotfiles-2756d3189374174f1e07a6df0f47d679fdc6e791.tar.gz
dotfiles-2756d3189374174f1e07a6df0f47d679fdc6e791.tar.bz2
dotfiles-2756d3189374174f1e07a6df0f47d679fdc6e791.zip
Translate asciidoc to markdown
(Last commit only changed filename)
Diffstat (limited to 'README.md')
-rw-r--r--README.md36
1 files changed, 16 insertions, 20 deletions
diff --git a/README.md b/README.md
index 6a1dbf0..5a68a9a 100644
--- a/README.md
+++ b/README.md
@@ -1,31 +1,28 @@
-= dotfiles
-Mitsuo
-2022-08-30
-:source-highlighter: highlight.js
+# dotfiles
My configuration settings and config files for various programs.
-== Usage
+## Usage
There is an installation script but it is work in progress. Currently it can
only install some of the config files.
-== Description
+## 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
+* 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
+<!-- TODO: finish this list -->
-////
+```
Some files are included in the installation script
profile sh config
@@ -42,20 +39,19 @@ Some files are included in the installation script
git/ Git config files
other/ Other config files
other/ideavimrc ~/.ideavimrc (Pycharm)
-////
+```
-== Installation
+## Installation
-[source, sh]
-----
+```sh
mkdir -p ~/mahcode
git clone --recurse-submodules https://github.com/zazke/dotfiles
cd dotfiles
-----
+```
-== Files currently requiring manual installation
+## Files currently requiring manual installation
-*st*: For emoji support: Install https://st.suckless.org/patches/font2/[font2]
+* `st`: For emoji support: Install https://st.suckless.org/patches/font2/[font2]
and https://aur.archlinux.org/packages/libxft-bgra[libxft-bgra]