Skip to content

Commit ca8542c

Browse files
author
Innes Anderson-Morrison
committed
chore: updating README
1 parent 9e43549 commit ca8542c

File tree

1 file changed

+14
-9
lines changed

1 file changed

+14
-9
lines changed

README.md

+14-9
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,12 @@
33
[![Build](https://github.com/sminez/ad/workflows/Build/badge.svg)](https://github.com/sminez/ad/actions?query=workflow%3ABuild) [![crates.io version](https://img.shields.io/crates/v/ad-editor)](https://crates.io/crates/ad-editor) [![docs.rs](https://img.shields.io/docsrs/ad-editor?logo=rust)](https://docs.rs/ad-editor)
44

55
`ad` (pronounced A.D.) is an attempt at combining a modal editing interface of likes of `vi`
6-
and `kakoune` with the approach to extensibility of Plan9's `Acme`. It is primarily intended
7-
as playground for experimenting with implementing various text editor features and currently
8-
is not at all optimised or feature complete enough for use as your main text editor.
6+
and `kakoune` with the approach to extensibility of Plan9's `Acme`. Inside of `ad` text is
7+
something you can execute as well as edit.
8+
9+
It is primarily intended as playground for experimenting with implementing various text editor
10+
features and currently is not at all optimised or feature complete enough for use as your main
11+
text editor.
912

1013
That said, if this sounds like something you might find interesting then please to take a
1114
look and see what you think! For now there isn't a whole lot of user facing documentation so
@@ -14,14 +17,16 @@ you will need to read through the source code to learn about what is and is not
1417

1518
## Project Status
1619

17-
This is not even remotely usable or stable enough for real world day-to-day use yet. All aspects of
18-
the code are changing constantly as I hack on things and try to work out how I want my ideal text
19-
editor to work.
20+
`ad` is stable enough and feature complete enough that you can try it out and see what you
21+
think. That said, there is currently very little documentation and there are likely to be
22+
a variety of bugs and crashes in places that I've not managed to fully track down yet. If
23+
you do try it out and spot something that is broken, please raise an issue on GitHub so I
24+
can look into it.
2025

2126
You have been warned!
2227

2328

24-
![screenshot](https://raw.githubusercontent.com/sminez/ad/develop/screenshot.png)
29+
[![tour](https://img.youtube.com/vi/jb2pAi5hLUg/0.jpg)](https://www.youtube.com/watch?v=jb2pAi5hLUg)
2530

2631

2732
## The design of ad
@@ -30,9 +35,9 @@ You have been warned!
3035
- vim style modal editing to allow for convenient key bindings
3136
- convenient text navigation and selection from vim/kakoune
3237
- mini-buffer based user defined minor modes from emacs
33-
- vim/sam/acme style editing commands for larger editing actions
38+
- sam/acme style editing commands for larger editing actions
3439
- acme style extension through exposing editor state and functionality for
35-
external client programs (though not as the _only_ way to add functionality).
40+
external client programs.
3641
- support for mouse based navigation and selection but not requiring that as the main
3742
way of using the editor like in acme. That's fine for desktop but most of the time
3843
I'm working with a laptop which makes that far too clunky.

0 commit comments

Comments
 (0)