aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorLeonardo Bishop <me@leonardobishop.com>2023-07-20 22:04:45 +0100
committerLeonardo Bishop <me@leonardobishop.com>2023-07-20 22:15:25 +0100
commitc3a55debe9e4194f83164d412293f27b797627af (patch)
tree027ca943a051bf51c809eec0f590d598df2db9a3 /README.md
Initial commit
Diffstat (limited to 'README.md')
-rw-r--r--README.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..798aa26
--- /dev/null
+++ b/README.md
@@ -0,0 +1,15 @@
+# dotfiles-installer
+
+Small program to automatically install my [dotfiles](https://github.com/LMBishop/dotfiles). Unless you happen to be me, I wouldn't recommend you use this.
+
+## Install
+
+Arch Linux only:
+```
+$ ./install.sh
+```
+
+## Usage
+```
+$ dotfiles-installer --file <FILE>
+``` \ No newline at end of file