devraza/dianciemacs
Archived
1
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity

docs: update README

Browse source
This commit is contained in:
Muhammad Nauman Raza 2023-07-01 16:29:58 +01:00
parent 27d51dbd42
commit a1a8e7f817
No known key found for this signature in database
GPG key ID: 4FFEEB78B8A620C7
1 changed files with 9 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
README.md
View file

@ -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.