summaryrefslogtreecommitdiffstats
path: root/README.md
blob: 0f2dfbd3066cc7eb80febe9ff28ce7192a952888 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
# Svgbob

<a href="https://crates.io/crates/svgbob"><img src="https://img.shields.io/crates/v/svgbob.svg" alt="svgbob’s current version badge" title="svgbob’s current version badge"></a><a href="https://travis-ci.org/ivanceras/svgbob">
<img src="https://api.travis-ci.org/ivanceras/svgbob.svg"/>
</a>

Svgbob is a utility tool and library for generating nice graphical representation from simple ascii diagrams.
It uses a combination of characters which are readily available in your keyboards.


Example ascii diagrams:

Rectangles:
```txt
+-------+    .--------.
|       |    |        |
+-------+    `--------'
```

Circle and arcs:
```txt

    ____            __  __
  ,'    `.        ,'      `.
 /        \      /          \
 \        /
  `.____.'       \          /
                  `.__  __.'

```


Interactive demo with more examples can be found [**here**](https://ivanceras.github.io/svgbob-editor/)


[Specification](https://ivanceras.github.io/content/Svgbob/Specification.html)


## TODO
- Support for pills with variable radius for the rounded corner

```txt

    _____________
  ,'             `.
 /   This is a     \
 \      pill       /
  `._____________.'


    _____________
  ,'             `.
 /   This is a     \
 |                 |
 |       v         |
 |       e         |
 |       r         |
 |       t         |
 |       i         |
 |       c         |
 |       a         |
 |       l         |
 |                 |
 \      pill       /
  `._____________.'
```
<a href="https://liberapay.com/ivanceras/donate"><img alt="Donate using Liberapay" src="https://liberapay.com/assets/widgets/donate.svg"></a>