Skip to content

Commit 57588d9

Browse files
committed
readme & contributing guide
1 parent be53ada commit 57588d9

File tree

2 files changed

+19
-4
lines changed

2 files changed

+19
-4
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,4 @@
1-
---
2-
title: Contributing
3-
---
1+
# Contributing
42

53
Contributions are welcome, and they are greatly appreciated! Every
64
little bit helps, and credit will always be given.

README.md

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,9 +26,26 @@ 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+
## Setup
30+
31+
1. Clone or download the current version from the `main` branch.
32+
33+
2. Install the Python module in development mode:
34+
35+
```shell
36+
$ python setup.py develop
37+
```
38+
39+
3. To verify, run the unit tests:
40+
41+
```shell
42+
$ pytest
43+
```
44+
45+
2946
## Contributing
3047

31-
TBA
48+
Your contributions are welcome. Please follow the [guide (CONTRIBUTING.md)](https://github.com/tuttle-dev/tuttle/blob/main/CONTRIBUTING.md).
3249

3350
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
3451

0 commit comments

Comments
 (0)