summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorSaumit Dinesan <justsaumit@protonmail.com>2023-05-23 20:09:48 +0530
committerSaumit Dinesan <justsaumit@protonmail.com>2023-05-23 20:09:48 +0530
commit904779ca5828f03a3f289433c4ad0cc4ed0fae7e (patch)
treeba39541d8e9058b0c10a1c7b810a519aede8e5cc /README.md
parentc42f0b64f3c2f51635978e40fd75b40d43d05426 (diff)
README: Updating README with Brief Look + short install guide
Diffstat (limited to 'README.md')
-rw-r--r--README.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..be38efc
--- /dev/null
+++ b/README.md
@@ -0,0 +1,16 @@
+# .nu_dotfiles
+Personal Arch Linux dotfiles for Wayland/Hyprland
+
+
+## Installation guide
+1. After a base install install Hyprland from pacman or via a AUR Helper
+2. git clone [.nu_dotfiles](https://github.com/justsaumit/.nu_dotfiles)
+3. Install waybar, foot terminal, imv, tofi and wpaperd
+4. Install the necessary fonts: ubuntu nerd mono, jetbrains nerd mono ,joypixels
+5. Copy/Replace the dotfiles
+
+## Brief look / Workflow
+![mini-project with vscodium](media/mini-project_workflow_vscodium.png)
+
+## License
+All the scripts in this repo come under GPLv3 License