Is your feature request related to a problem? Please describe.
Currently there's no README.md, write one to inform both self and other users what this is, show screenshots, etc.
Describe the solution you'd like
Write a clearly structured README.md with the following sections:
[ ] Introduction
[ ] Add badges? Like commitizen/cz-cli or that the config uses snowfall and flakes?
[ ] A short feature list (maybe 5 features?)
[ ] A short list of planned but missing features (maybe 3 to 5 features?)
[ ] Screenshots
[ ] Show things like desktop, terminal, some application(s), etc. (max 5 images in README.md)
[ ] Mention a directory/folder where more images are, can't show all in README.md
[ ] Markdown file with install instructions, like ./INSTALL.md
[ ] Table of content
[ ] Mention if there's an install script along with supported environments
[ ] Write instructions for
[ ] Rescue environment
[ ] Uninstall configuration
[ ] Update system/packages/etc.
[ ] Collaboration? Contact?
[ ] Credits for inspiration, pieces of code, features, etc.
Additionally, somewhere within the file mention where wallpapers are stored for those interested.
Mention that snowfallorg/lib is used and maybe relevant project file structure?
Is your feature request related to a problem? Please describe. Currently there's no
README.md
, write one to inform both self and other users what this is, show screenshots, etc.Describe the solution you'd like Write a clearly structured
README.md
with the following sections:README.md
)README.md
./INSTALL.md
Additionally, somewhere within the file mention where wallpapers are stored for those interested.
Mention that snowfallorg/lib is used and maybe relevant project file structure?
Describe alternatives you've considered None
Additional context None