Skip to content

Commit

Permalink
Add README.md for the Vegravis project
Browse files Browse the repository at this point in the history
📄(README): created README.md

which introduces and gives important details about the Vegravis project. The file notably contains an introduction, a snapshot of the application, installation instructions, features list, and licensing details.

Signed-off-by: Benign X <[email protected]>
  • Loading branch information
W-Mai committed Nov 19, 2023
1 parent 8885f6b commit 7a11ae8
Show file tree
Hide file tree
Showing 3 changed files with 75 additions and 0 deletions.
75 changes: 75 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
<img height="256" src="assets/maskable_icon_x512.png" alt="Vegravis Logo" align="right"/>
<div style="display: flex; justify-content: space-between; flex:8">
<h1 align="left">Vegravis</h1>

<div align="left">
<img src="https://img.shields.io/static/v1?label=Awesome&message=Project&style=for-the-badge&color=blue&logo=glass" alt="Awesome Badge"/>

<a href="https://jq.qq.com/?_wv=1027&k=8Z9w4LGN"><img src="https://img.shields.io/badge/QQ%20Group-join-black?style=for-the-badge&logo=linux" alt="Join Community Badge"/></a>
<br>

<i>Vector Graphics Visualizer</i>

<a href="https://github.com/W-Mai/vegravis/stargazers"><img src="https://img.shields.io/github/stars/W-Mai/vegravis?style=for-the-badge&" alt="Stars Badge"/></a>
<a href="https://github.com/W-Mai/vegravis/network/members"><img src="https://img.shields.io/github/forks/W-Mai/vegravis?style=for-the-badge&" alt="Forks Badge"/></a>
<a href="https://github.com/W-Mai/vegravis/issues"><img src="https://img.shields.io/github/issues/W-Mai/vegravis?style=for-the-badge&" alt="Issues Badge"/></a>
<a href="https://github.com/W-Mai/vegravis/blob/master/LICENSE"><img src="https://img.shields.io/github/license/W-Mai/vegravis?color=2b9348&style=for-the-badge&" alt="License Badge"/></a>

</div>
</div>

<img src="snapshots/snapshot.png">

## Introduction

Vegravis is a vector graphics visualizer.
It can visualize vector graphics on a canvas, and can also visualize vector graphics in other formats through
conversion.

like codes below:

```shell
// Sakaban Turtle
move, -100, 0,
quad, 0,-10,100, 0,
cubi, 100, -100, -100, -100, -100, 0,
cubi, -100, 100, 100, 100, 100, 0,
move, 70, 30,
cubi, 70, 55, 30, 55, 30, 30,
cubi, 30, 5, 70, 5, 70, 30,

move, 55, 30,
cubi, 55, 40, 45, 40, 45, 30,
cubi, 45, 20, 55, 20, 55, 30,

move, -70, 30,
cubi, -70, 55, -30, 55, -30, 30,
cubi, -30, 5, -70, 5, -70, 30,

move, -55, 30,
cubi, -55, 40, -45, 40, -45, 30,
cubi, -45, 20, -55, 20, -55, 30,

move, 30, -4,
quad, 0, -60, -30, -4
```

and you will get a cute Sakaban Turtle:

<img src="snapshots/sakaban.png" width="200">

## Features

- [x] Visualize vector graphics
- [x] Support cross-platform (**Windows**, **Linux**, **MacOS**, **Web**)
- [ ] Support multiple vector graphics formats
- [ ] Support vector graphics editing
- [ ] Support vector graphics animation
- [x] Support custom vector grammar
- [x] Support custom vector grammar editor
- [x] Support grammar error detection
- [ ] ...

## LICENSE

MIT
Binary file added snapshots/sakaban.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added snapshots/snapshot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 7a11ae8

Please sign in to comment.