Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
joshuabach committed Jan 7, 2024
1 parent bbe252b commit 0b1769c
Show file tree
Hide file tree
Showing 4 changed files with 19 additions and 11 deletions.
30 changes: 19 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -212,22 +212,25 @@ Initialise submodules and install dependencies:
```sh
git submodule init
git submodule update
pip install -r requirements.txt

pip install -r src/requirements.txt
```

Run it:
```sh
export FLASK_APP=gnucash_web
export FLASK_ENV=development
flask run
cd src/gnucash_web/
flask run --debug
```

Build and upload package:
```sh
python -m build
python -m twine upload dist/*
```

Make new release:
- Update version number in *src/gnucash_web/version.txt*
- Build and upload package
```sh
cd src/
python -m build
python -m twine upload dist/gnucash_web-$VERSION*
```
- Tag commit and create release on GitHub

Contributing
------------
Expand All @@ -239,7 +242,12 @@ needs and intellectual curiosity.

Since *GnuCash Web* fulfills my primary use case for it, I don't expect much development
in the near future. However, if anyone is willing to help taking this into a more
feature-rich direction, I am motivated to work on that.
feature-rich direction, I am motivated to work on that, though time is naturally scarce.
Please note that my primary user is myself and any changes must be compatible with my
use case and workflows. I will also not accept changes or additions that I cannot
gauarantee to maintain in the future. Simplicity is more important to me than
features, so please consider this and talk to me before spending time on big changes.
See [Issues](https://github.com/joshuabach/gnucash-web/issues) and
[Milestones](https://github.com/joshuabach/gnucash-web/milestones) for some ideas on how
Expand Down
Binary file modified screenshots/book.accounts.ledger.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified screenshots/book.accounts.ledger.transaction-edit.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified screenshots/book.accounts.list.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 0b1769c

Please sign in to comment.