This repository has been archived on 2024-03-23. You can view files and clone it, but cannot push or open issues or pull requests.
dianciemacs/README.md

49 lines
2.1 KiB
Markdown
Raw Permalink Normal View History

2022-11-12 17:41:25 +00:00
# Dianciemacs
2022-11-12 18:55:32 +00:00
Dianciemacs is a minimal and elegant Emacs distribution for those who prefer simplicity and aesthetics.
2023-11-13 09:49:12 +00:00
The current default theme used is a custom theme called `hazakura` (on this server).
2023-07-01 16:29:58 +01:00
> The interface has been designed to work with this theme, so be careful when making changes!
2022-11-12 18:55:32 +00:00
Internal modules such as keybinds, macros, etc. are named with `diancite` for simplicity and readability.
2023-07-01 16:59:46 +01:00
![An image of Dianciemacs](screenshot.png)
2022-11-12 18:55:32 +00:00
## Prerequisites
Dianciemacs requires the following prerequisits to be installed or run:
- Git `2.38+`
- Emacs `28.2+`
## Installation
2023-07-01 16:29:58 +01:00
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`)
2022-11-12 18:55:32 +00:00
```
git clone https://git.devraza.duckdns.org/devraza/dianciemacs.git ~/.config/emacs
2022-11-12 18:55:32 +00:00
```
## Configuration
2023-07-01 16:29:58 +01:00
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.
2022-11-12 18:55:32 +00:00
## Development
2023-07-01 16:29:58 +01:00
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.
2022-11-12 18:55:32 +00:00
2023-07-01 16:29:58 +01:00
This project will definitely undergo several (likely **breaking**) changes as it matures - something you should note if you're using Dianciemacs.
2022-11-12 18:55:32 +00:00
### Roadmap
2023-07-01 16:29:58 +01:00
The following list contains the major features which are yet to be implemented:
2022-11-12 18:55:32 +00:00
2022-12-19 09:02:26 +00:00
- [ ] Configuration macros (such as `package!` or `hook!`)
- [ ] Command-line tool to manage configuration
- [X] User configuration in a user directory - `user/`
2022-11-12 18:55:32 +00:00
## Contribution
2023-07-01 16:29:58 +01:00
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.
2022-11-12 18:55:32 +00:00