splatplost icon indicating copy to clipboard operation
splatplost copied to clipboard

Enhance documentation

Open Victrid opened this issue 2 years ago • 2 comments

The documentation in README.md is rather misleading, as bluetooth over virtual machine or windows is rather badly supported.

The program is only tested on linux on bare metal machine, and we need documentation to address that.

Furthermore, it's possible that we provide a Linux image, to be burnt onto some USB drive, and user can plot this out of box.

This issue is posted in order to replace:

  • https://github.com/Victrid/splatplost/issues/8
  • https://github.com/Victrid/splatplost/issues/9

Victrid avatar Aug 26 '22 02:08 Victrid

Also, if user uses Chinese, others may have difficulties reading them, and raise duplicate questions in different languages.

Adding a short introduction of DeepL translator to documentation would be good.


另外,如果用户使用中文,其他人可能难以阅读,并提出不同语言的重复问题。

在文档中加入DeepL translator的简短介绍会比较好。

Victrid avatar Aug 26 '22 02:08 Victrid

A Linux image would be nice, as right now setting it up manually is very confusing and basically takes a lot of time for people like me who try it for the first time. The project itself is very pog though, so keep up the good work.

TattlingElk avatar Aug 30 '22 22:08 TattlingElk