add README.md

1 files changed, 41 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..a2e89a6
--- /dev/null
+++ b/README.md
@@ -0,0 +1,41 @@
+# Joursoir's dotfiles
+
+Yo fellow, feel free to explore, adapt, and use any part of my dotconfig that you find useful.
+
+
+## Software I Use
+
+- **Browser**: Firefox / [Palemoon](https://www.palemoon.org/)
+- **File Manager**: Thunar
+- **Mail Client**: sylpheed (outdated) / [Claws Mail](https://www.claws-mail.org/)
+- **PDF Viewer**: xreader
+- **Photo Viewer**: ristretto
+- **Text Editor**: Sublime Text
+- **Terminal Emulator**: Terminator
+- **Crypto Wallet**: electrum
+- **IRC client**: HexChat
+- **Screen Cast**: [vokoscreen](https://linuxecke.volkoh.de/vokoscreen/vokoscreen.html) 
+
+
+## Configurations and Tools Provided
+
+- **bash**: Customized bash settings, including aliases, environment variables, and prompt configurations.
+- **grub**: Configuration for the GRUB bootloader.
+- **dotconfig/i3**: Tiling window manager configuration.
+- **dotconfig/polybar**: Status bar configuration.
+- **scripts**: A directory containing helpful shell scripts for various tasks.
+
+## Installation / usage
+
+For fast installation of my dotconfigs, you can use the `make` command with the available options: `bash`, `grub`, `i3`, `polybar`
+
+
+## Additional Resources
+
+- [Pacman cheatsheet](https://devhints.io/pacman)
+- [i3 Reference Card](https://i3wm.org/docs/refcard.html)
+
+
+## License
+
+This repository is licensed under the MIT License. You are free to use, modify, and distribute these configurations.