diff options
| author | Albert Cervin <albert@acervin.com> | 2024-03-14 08:57:10 +0100 |
|---|---|---|
| committer | Albert Cervin <albert@acervin.com> | 2024-03-14 08:57:10 +0100 |
| commit | eabf7f9a958026c073faecf7504cbd8bb484a6c1 (patch) | |
| tree | d806c0fc38fb38054e5aab7e9dc4fcb70246da22 /README.md | |
| parent | cd87d88a930a0b58cfca38678d2e757491c17b26 (diff) | |
| download | dged-eabf7f9a958026c073faecf7504cbd8bb484a6c1.tar.gz dged-eabf7f9a958026c073faecf7504cbd8bb484a6c1.tar.xz dged-eabf7f9a958026c073faecf7504cbd8bb484a6c1.zip | |
Update README and man page
Add all commands and keybinds to the manual.
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 63 |
1 files changed, 61 insertions, 2 deletions
@@ -3,18 +3,77 @@ Because there is room for one more minimalistic text editor! DGED is what happens if I remove everything I do not need from -GNU Emacs and only implement the things I personally need to be productive. +GNU Emacs and only implement the things I need to be productive. The editor was created as a learning exercise and to create something that I -can use as a daily driver. +can use as a daily driver. If anyone else happens to find it useful I will +be flattered and suprised. ## Features - [x] Syntax highlighting - [x] TOML configuration file +- [x] Editor commands (M-x) - [x] Absolutely no plugin system +- [x] Terminal only +- [x] Mouse-free editing - [ ] LSP Client implementation ## Contributing Contributions are of course welcome. Please open a PR on the Github repository. + +## Development Setup + +The editor is built using BSD make so that needs to be installed. + +To enable syntax highlighting (default) you will also need the tree-sitter library +installed. + +All of this can be obtained using the Nix flake. To create a development shell with all +needed dependencies, issue: + +``` +$ nix develop +``` +Currently, tree-sitter grammars can only be automatically fetched when using the Nix setup. + +To build the editor, first create the build folder + +``` +$ mkdir -p build +``` + +Then call make + +``` +$ bmake +``` + +## Installing + +If using nix, installation can be done by referring the flake with for example `nix profile`: + +``` +$ nix profile install . +``` + +or by using `home-manager` or `configuration.nix`. + +If not using Nix, obtain the needed dependencies and then issue + +``` +$ make +``` + +followed by + +``` +# make install +``` + +Optionally, you can set `prefix` to a value of your liking. + +## Documentation + +The features of the editor are documented in the man page (`man dged`). |