Merge pull request #152 from gh2hq/v2

V2

Author: pearmini

.gitignore

@@ -5,4 +5,7 @@ dist/
 .vscode
 venv
 *.egg-info
-*.log
+*.log
+.pytest_cache
+node_modules
+**/.vitepress/cache

LICENSE

@@ -1,4 +1,4 @@
-Copyright 2020-present Pearmini https://github.com/pearmini
+Copyright 2020-present Bairui SU https://github.com/pearmini
 
 Permission to use, copy, modify, and/or distribute this software for any purpose
 with or without fee is hereby granted, provided that the above copyright notice

README.md

@@ -1,69 +1,3 @@
-# Charming.py: Character Terminal Art Programming
+# gh2
 
-Charming.py is a creative coding language designed for **Character Terminal Art Programming**.
-
-It is currently written in Python and provides Processing-like APIs, which aims to help artists, designers, educators, beginners, and anyone else to easily create following visual effects in terminal.
-
-- [ASCII Art Animation](./docs/examples/readme.md#ASCII-Art-Animation)
-- [Character-Style Generative Art](./docs/examples/readme.md#Character-Style-Generative-Art)
-- [Terminal Game Application](./docs/examples/readme.md#Terminal-Game-Application)
-- [Expressive Data Visualization](./docs/examples/readme.md#Expressive-Data-Visualization)
-
-There are many reasons for creating Charming.py, but the most important one is that **I hope not only does Charming.py make you love programming for fun or show a magic world to you, but also make this journey relaxing and interesting.**
-
-<img src="https://raw.githubusercontent.com/gh2hq/public-files/master/cover.png" alt="cover" width="100%">
-
-## 📎 Links
-
-- [Introduction](./docs/introduction.md)
-- [Tutorials](./docs/tutorials/readme.md)
-- [API Reference](./docs/api/readme.md)
-- [Examples](./docs/examples/readme.md)
-- [Processing&P5.js to Charming.py](./docs/processing&p5js-to-charming.md)
-
-## ✨ Features
-
-- **Highly Expressive**: Unlike traditional drawing system or tool using three numerical channels (`(r, g, b)` or `(h, s, v)`) to describe a color, Charming.py allows you to describe a color like `(character, foreground color, background color)`, which means you can express more with the extra the `character` channel.
-- **Powerful and Flexible**: Charming.py is not as same as [urwid](https://github.com/urwid/urwid) or [click](https://github.com/pallets/click) to build console line interface. Actually it more like [asciimatics](https://github.com/peterbrittain/asciimatics), [art](https://github.com/sepandhaghighi/art) or [tcharts](https://github.com/ProtoTeam/tcharts.js) to draw some visual effects in the terminal but with more flexibility. Instead of drawing limited and predefined shapes or effects, you can draw some basic primitives, custom shapes, curves, images, typography with transforms (translate, rotate, shear) and even events (mouse, keyboard) in Charming.py.
-- **Easy to Learn and Use**: Charming.py is very beginner-friendly, because of Python's simple syntax and [Processing](https://processing.org/)'s concise APIs. It will be more easier if you are already familiar with them. Once you've master Charming.py, you can create anything interesting in you head with it and enjoy the pure joy of coding.
-
-<img src="https://raw.githubusercontent.com/gh2hq/public-files/master/hello_world.gif" alt="Charming" width="100%">
-
-## 📦 Installation
-
-- **Supported OS**: Charming.py currently only supports **MacOS**, though it should also work for any other platform that provides a working [curses](https://docs.python.org/3/howto/curses.html) implementation. It soon will support **Windows** and run in **Modern Browsers**.
-- **Python**: 3.6/3.7/3.8
-
-```bash
-$ pip3 install charming --user
-```
-
-## 📺 A Simple Example
-
-```python
-'''rect.py'''
-import charming as cm
-
-# draw a rect
-cm.full_screen()
-cm.rect(0, 0, 10, 10)
-
-# run the sketch
-cm.run()
-```
-
-```bash
-$ python3 rect.py
-```
-
-![get started](https://raw.githubusercontent.com/gh2hq/public-files/master/get_started.png)
-
-## 🛸 Future work
-
-- Using Rust as backend to run in browser and support multiple OS, using both JavaScript and Python as frontend.
-- Add more API to be more expressive.
-- Build a community and online playground like OpenProcessing.
-
-## 💳 License
-
-Charming.py is [LGPL-2.1 License](./LICENSE).
+The creative coding language for ASCII art and poetic form.