From a1a8e7f817f036bddbdd3f393a7373c67c1859ec Mon Sep 17 00:00:00 2001 From: Muhammad Nauman Raza Date: Sat, 1 Jul 2023 16:29:58 +0100 Subject: [PATCH] docs: update README --- README.md | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index bd9be12..e488720 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,9 @@ Dianciemacs is a minimal and elegant Emacs distribution for those who prefer simplicity and aesthetics. +The current default theme used is a custom theme called [hazakura](https://github.com/devraza/hazakura-emacs). +> The interface has been designed to work with this theme, so be careful when making changes! + Internal modules such as keybinds, macros, etc. are named with `diancite` for simplicity and readability. ## Prerequisites @@ -13,7 +16,7 @@ Dianciemacs requires the following prerequisits to be installed or run: ## Installation -To install Dianciemacs, first clone the repository to your appropriate Emacs directory - generally `~/.emacs.d` for Linux and macOS. +To install Dianciemacs, first clone the repository to your appropriate Emacs directory - generally `~/.emacs.d` for Linux and macOS - alternatively, `$XDG_CONFIG_HOME/emacs` may also be used (typically `~/.config/emacs`) ``` git clone https://github.com/devraza/dianciemacs ~/.emacs.d @@ -21,17 +24,17 @@ git clone https://github.com/devraza/dianciemacs ~/.emacs.d ## Configuration -If you wish to make your changes to the default configuration, simply make any changes to the the `init.el` file in the `user/` directory - this directory is reserved completely to users, so feel free to add any extra files. +If you wish to make your changes to the default configuration, simply make any desired changes to the the `init.el` file in the `user/` directory - this directory is (as implied by its name) reserved for user configuration, so feel free to add any extra files. ## Development -Dianciemacs is currently walking it's first steps. As such, there's a lot of functionality it doesn't have that most Emacs configuration frameworks do. +Dianciemacs, as of the time of writing, works well as an Emacs configuration - but that's about it. Feature-parity with other Emacs configuration *frameworks* is planned, but, truth be told, it's abysmal right now. I recommend you give this config a try nevertheless. -This project will definitely undergo several (possibly **breaking**) changes as it matures - something you should note if you're considering using Dianciemacs. +This project will definitely undergo several (likely **breaking**) changes as it matures - something you should note if you're using Dianciemacs. ### Roadmap -The following list contains the features which are yet to be implemented: +The following list contains the major features which are yet to be implemented: - [ ] Configuration macros (such as `package!` or `hook!`) - [ ] Command-line tool to manage configuration @@ -39,5 +42,5 @@ The following list contains the features which are yet to be implemented: ## Contribution -Contributions are very welcome! I don't know much about Emacs lisp, so if you want a cool feature (that I may or may not have on the roadmap) and have the e-lisp proficiency, I'll happily accept it. +Contributions are very welcome! Honestly speaking, I don't know all there is to know about Emacs/lisp, so if you want a cool feature (that I may or may not have on the roadmap) and have the e-lisp proficiency, I'll happily consider it.