double-entry-generator icon indicating copy to clipboard operation
double-entry-generator copied to clipboard

docs: Add a quick start guide

Open gaocegege opened this issue 9 months ago • 3 comments

We could provide a quick start, giving a simple Alipay/Wechat fake records, and explain how to write config rules for it.

Ref https://github.com/deb-sig/double-entry-generator/issues/151#issuecomment-2781818117

gaocegege avatar Apr 07 '25 01:04 gaocegege

I'd like to report one point that may upset new users:

double-entry-generator translate --provider wechat --config no-file.yml ~/Downloads/wechat.csv

When the configuration file does not exist and the account file does exist, the following error message is emitted:

2025/04/07 09:50:00 Failed to get default options in config

which is a little bit ... overwhelmed. A user may wonder that what is a "config" and why the program fails to get the "default options"? (I did when I was a newbie.) We can provide more user-friendly error message in this case, such as "warning/error: the config file no-file.yml does not exist".

rennsax avatar Apr 07 '25 01:04 rennsax

Maybe the examples/ is a good starting point.

Triple-Z avatar Apr 07 '25 03:04 Triple-Z

Image 应该是这个快速上手的参数配置已经落后了,我也是用了这个示例发现报错了

TerrySolar avatar Nov 14 '25 09:11 TerrySolar