Skip to content

Commit af1ee2d

Browse files
committed
README update: product vision
1 parent c5f5c72 commit af1ee2d

File tree

1 file changed

+14
-2
lines changed

1 file changed

+14
-2
lines changed

README.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,17 +26,29 @@ The application provides analysis and forecasting functions on income, expenses,
2626
We develop the solution as a GUI application based on web technologies. Sensitive financial data is processed locally on the end device without central data collection. For data analysis, we rely on open source tools from the Python ecosystem.
2727

2828

29+
## What is the product vision?
30+
31+
Desktop apps are great - let's have more of them. We are consciously developing a desktop app with local data storage, not a web app, since your business data is none of our business.
32+
33+
For this purpose, the Tuttle project is split across several repositories:
34+
35+
- This repository contains the core library, written in Python.
36+
- The desktop application frontend, based on Electron.js, is being developed in [tuttle-dev/tuttle-app-electron](https://github.com/tuttle-dev/tuttle-app-electron)
37+
38+
2939
## Setup
3040

3141
1. Clone or download the current version from the `main` branch.
3242

33-
2. Install the Python module in development mode:
43+
2. We recommend installation into a new [virtual environment](https://calmcode.io/virtualenv/intro.html).
44+
45+
3. Install the Python module in development mode:
3446

3547
```shell
3648
$ python setup.py develop
3749
```
3850

39-
3. To verify, run the unit tests:
51+
4. To verify, run the unit tests:
4052

4153
```shell
4254
$ pytest

0 commit comments

Comments
 (0)