feat(docs): add an FAQ to the repo

This commit is contained in:
Sergio Laín 2024-08-09 00:26:52 +02:00
parent 464cf3952e
commit 9f2bc18f7e
No known key found for this signature in database
GPG key ID: 8429B2EE312F8150
2 changed files with 27 additions and 2 deletions

25
.github/FAQ.md vendored Normal file
View file

@ -0,0 +1,25 @@
# Frequently Asked Questions
## Does your dotfiles have an automatic installation? If not, are you planning on doing it?
No, I dont have any and im not planning on doing it. The main reason is the hasle that is to maintain an install script.
The automatic scripts are also "mainly" used without even checking on the code itself, which I think is pretty risky and should be avoided.
I feel like that way you dont also learn how to install the config which in some cases leds to not understanding what you're doing.
Sorry about it!
Even then, the installation steps are pretty easy and straightforward so everybody should be able to do follow them. If not, then that is a mistake on my part :)
## Are you planning on documenting the keybindings?
Nop. I dont feel it is neccesary because at some applications they can be seen on the help menu or just by looking at the config file.
Maybe at some point I'll update my [keyb config](../.config/keyb/) so that the important bindings will be available there.
## Are custom themes something you'd introduce in the future?
Maybe. At least for me, I'm not going to use them. I like to stick to one theme only; in this case Catppuccin Macchiato.
But I understand that a lot of people like it, so if I have the time and the effort I'll do it; but it will take a lot of time to implement tho ;)

4
.github/README.md vendored
View file

@ -339,7 +339,7 @@ Then, be sure to push your changes to your remote!
Now you can receive new updates from my repo and modify your custom one :sunglasses:
If you had any issues or you have some questions about the installation process, feel free to [open an issue](https://github.com/Matt-FTW/dotfiles/issues/new/choose) or a [new discussion post](https://github.com/Matt-FTW/dotfiles/discussions/new/choose)
If you had any issues or you have some questions about the installation process, feel free to [open an issue](https://github.com/Matt-FTW/dotfiles/issues/new/choose) or a [new discussion post](https://github.com/Matt-FTW/dotfiles/discussions/new/choose). Be sure to read the [FAQ](./FAQ.md) first!
- ### <samp>Git Method (_Classic method_, **not recommended**)</samp>
@ -362,7 +362,7 @@ Congratulations, at this point your done installing the configuration! :tada:
Logout from your current desktop session and log back into the Hyprland session.
If you had any issues or you have some questions about the installation process, feel free to [open an issue](https://github.com/Matt-FTW/dotfiles/issues/new/choose) or a [new discussion post](https://github.com/Matt-FTW/dotfiles/discussions/new/choose)
If you had any issues or you have some questions about the installation process, feel free to [open an issue](https://github.com/Matt-FTW/dotfiles/issues/new/choose) or a [new discussion post](https://github.com/Matt-FTW/dotfiles/discussions/new/choose). Be sure to read the [FAQ](./FAQ.md) first!
# :camera: <samp>Gallery</samp>