首页
/ hledger 项目使用教程

hledger 项目使用教程

2024-08-11 13:10:13作者:江焘钦

1. 项目的目录结构及介绍

hledger 项目的目录结构如下:

hledger/
├── bin/
├── data/
├── doc/
├── hledger-lib/
├── hledger-ui/
├── hledger-web/
├── scripts/
├── src/
├── tests/
├── CHANGELOG.md
├── CONTRIBUTING.md
├── LICENSE
├── README.md
├── SETUP.md
├── hledger.cabal
└── stack.yaml

目录介绍:

  • bin/:包含可执行文件。
  • data/:包含示例数据文件。
  • doc/:包含项目文档。
  • hledger-lib/:hledger 的核心库。
  • hledger-ui/:hledger 的文本用户界面。
  • hledger-web/:hledger 的 Web 界面。
  • scripts/:包含一些脚本文件。
  • src/:包含源代码文件。
  • tests/:包含测试文件。
  • CHANGELOG.md:项目更新日志。
  • CONTRIBUTING.md:贡献指南。
  • LICENSE:项目许可证。
  • README.md:项目介绍和使用说明。
  • SETUP.md:项目设置指南。
  • hledger.cabal:Cabal 构建文件。
  • stack.yaml:Stack 构建文件。

2. 项目的启动文件介绍

hledger 项目的启动文件主要位于 bin/ 目录下,包括以下几个主要可执行文件:

  • hledger:hledger 的主命令行工具。
  • hledger-ui:hledger 的文本用户界面工具。
  • hledger-web:hledger 的 Web 界面工具。

启动文件介绍:

  • hledger:用于执行各种会计操作,如查询、报表生成等。
  • hledger-ui:提供一个基于文本的用户界面,方便在终端中进行交互操作。
  • hledger-web:提供一个基于 Web 的用户界面,方便通过浏览器进行操作。

3. 项目的配置文件介绍

hledger 项目的配置文件主要包括以下几个部分:

  • hledger.cabal:Cabal 构建文件,定义了项目的依赖、源文件、测试等。
  • stack.yaml:Stack 构建文件,定义了项目的 Stack 配置和依赖。
  • .hledger.conf:hledger 的配置文件,用于定义默认选项、报表格式等。

配置文件介绍:

  • hledger.cabal:包含项目的元数据、依赖库、源文件路径等信息。
  • stack.yaml:定义了 Stack 工具的配置,包括 resolver、extra-deps 等。
  • .hledger.conf:用户自定义的配置文件,可以设置默认的报表格式、货币单位等选项。

以上是 hledger 项目的基本使用教程,涵盖了项目的目录结构、启动文件和配置文件的介绍。希望对您有所帮助。

登录后查看全文
热门项目推荐
相关项目推荐