EvergreenCrypto/dfi-docs
1
1
Fork 1
Code Issues 4 Pull Requests Releases 4 Activity

Migrate (and update) docs from 'docker-finance' repo to 'dfi-docs' repo

Browse Source 
- Moves all documentation to this repository
- Updates markdown to reflect latest impl
- Updates assets to reflect latest impl
  * Assets are also now more self-documenting
  * Adds utility script to create gif examples
This commit is contained in:
Aaron Fiore
2025-10-28 16:40:51 -07:00
commit 845d826f29
79 changed files with 1862 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

58
README.md Normal file
View File

@@ -0,0 +1,58 @@
[//]: # (docker-finance | modern accounting for the power-user)
[//]: # ()
[//]: # (Copyright [C] 2021-2025 Aaron Fiore [Founder, Evergreen Crypto LLC])
[//]: # ()
[//]: # (This program is free software: you can redistribute it and/or modify)
[//]: # (it under the terms of the GNU General Public License as published by)
[//]: # (the Free Software Foundation, either version 3 of the License, or)
[//]: # ([at your option] any later version.)
[//]: # ()
[//]: # (This program is distributed in the hope that it will be useful,)
[//]: # (but WITHOUT ANY WARRANTY; without even the implied warranty of)
[//]: # (MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the)
[//]: # (GNU General Public License for more details.)
[//]: # ()
[//]: # (You should have received a copy of the GNU General Public License)
[//]: # (along with this program. If not, see <https://www.gnu.org/licenses/>.)
<div align="center">
[<img src="assets/branding/png/docker-finance.png" height=75% width=75% align="center" />](https://gitea.com/EvergreenCrypto/docker-finance "docker-finance")
</div>
<div align="center">
<img src="assets/branding/png/dfi.png" height=3% width=3% /> (docker-finance) is a [quasi-"financial operating system"](markdown/What-does-it-do.md) of accounting for [variant ledgers and metadata](markdown/What-is-supported.md).
After [installing and configuring](markdown/How-do-I-get-started.md), you can [learn how to use `dfi`](markdown/How-do-I-use-it.md). You can also [contribute](markdown/How-do-I-contribute.md) or [reach out](markdown/How-do-I-connect.md) at any time.
Please, consider the [legalese](markdown/Where-is-the-legalese.md) before using (or copying) this repository. All other documentation can be found [here](markdown).
</div>
<br>
<div align="center">
[<img src="assets/examples/gif/client.gif" width=22.5% height=22.5% />](markdown/What-does-it-do.md#image-finance "image: finance")
[<img src="assets/examples/gif/dev-tools.gif" width=22.5% height=22.5% />](markdown/What-does-it-do.md#image-dev-tools "image: dev-tools")
[<img src="assets/examples/gif/fetch.gif" width=22.5% height=22.5% />](markdown/What-does-it-do.md#fetch "Fetch prices, remote accounts and blockchain data")
[<img src="assets/examples/gif/hledger-suite.gif" width=22.5% height=22.5% />](markdown/What-does-it-do.md#hledger-suite "hledger-suite")
[<img src="assets/examples/gif/meta.gif" width=22.5% height=22.5% />](markdown/What-does-it-do.md#meta-w-root-c-analysis "Meta (w/ ROOT C++ analysis)")
[<img src="assets/examples/gif/root.gif" width=22.5% height=22.5% />](markdown/What-does-it-do.md#root-cli-w-c-api "ROOT (CLI w/ C++ API)")
[<img src="assets/examples/gif/taxes.gif" width=22.5% height=22.5% />](markdown/What-does-it-do.md#taxes "Tax preparation")
[<img src="assets/examples/gif/reports.gif" width=22.5% height=22.5% />](markdown/What-does-it-do.md#reports "Financial reports")
</div>
---
<div align="center">
To develop this repository and/or render it locally, you can install [Gitea](https://docs.gitea.com/installation/install-with-docker-rootless).
</div>
[//]: # (vim: sw=2 sts=2 si ai et)