Skip to content

Commit a31f30f

Browse files
committed
📚 Start a proper README
1 parent fc21f26 commit a31f30f

File tree

3 files changed

+16
-3
lines changed

3 files changed

+16
-3
lines changed

README.md

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,24 @@
11
# textual-mandelbrot
22

3+
![mandelexp in action](https://raw.githubusercontent.com/davep/textual-mandelbrot/main/img/mandelexp01.png)
4+
![mandelexp in action](https://raw.githubusercontent.com/davep/textual-mandelbrot/main/img/mandelexp02.png)
5+
36
## Introduction
47

5-
Barely working at the moment. Come back later.
8+
This packages provides a simple Mandelbrot set widget that can be used in
9+
[Textual](https://textual.textualize.io/) applications, and also provides an
10+
application that can be used to explore the classic Mandelbrot set in the
11+
terminal.
12+
13+
## Installing
14+
15+
The package can be installed using [`pipx`](https://pypa.github.io/pipx/):
616

7-
## TODO
17+
```sh
18+
$ pipx install textual-mandelbrot
19+
```
820

9-
Pretty much everything. Check back soon.
21+
Once installed you should be able to run the command `mandelexp` and the
22+
application will run.
1023

1124
[//]: # (README.md ends here)

img/mandelexp01.png

129 KB
Loading

img/mandelexp02.png

143 KB
Loading

0 commit comments

Comments
 (0)