From 1299fe469d3f8665eea4a50c5676ed581c627b55 Mon Sep 17 00:00:00 2001 From: Ad5001 Date: Sat, 21 Sep 2024 03:21:49 +0200 Subject: [PATCH] Updating README --- README.md | 24 +++++++++++------------- poetry.lock | 2 +- pyproject.toml | 6 ++++-- 3 files changed, 16 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 0745682..3dd1378 100644 --- a/README.md +++ b/README.md @@ -11,13 +11,13 @@ ![Phase example](https://apps.ad5001.eu/img/en/logarithmplotter/phase.png) ![Object settings](https://apps.ad5001.eu/img/en/logarithmplotter/object-settings.webp) -You can find more screenshots on the [app website](https://apps.ad5001.eu/logarithmplotter/). +You can find more screenshots on the [app's website](https://apps.ad5001.eu/logarithmplotter/). ## Run You can simply run LogarithmPlotter using `python3 run.py`. -In order to test translations, you can use the `--lang=` commandline option to force the locale of LogarithmPlotter. +In order to test translations, you can use the `--lang=` commandline option to force the locale. ## Install @@ -25,18 +25,15 @@ In order to test translations, you can use the `--lang=` commandline All scripts noted here can be found in the `scripts` directory. You can generate installers for LogarithmPlotter after installing all the dependencies: -For all builds, you need [Python 3](https://python.org) with [PySide6](https://pypi.org/project/PySide6/) installable with `pip install PySide6`. +For all builds, you will need [Python 3](https://python.org) with [poetry](https://python-poetry.org/), and `poetry install --with packaging`. - Windows installer: - - You need `pyinstaller`. You can install it using `pip install pyinstaller`. - Run the `build-windows.bat` script (or `build-wine.sh` if you're cross-compiling with wine on Linux) to build an exe for LogarithmPlotter. - You also need [NSIS](https://nsis.sourceforge.io/Main_Page) (Linux users can install the [nsis](https://pkgs.org/download/nsis) package). - - Run the `package-windows.bat` script (or `package-wine.sh`if you're cross-compiling on Linux). You will find a logarithmplotter-setup.exe installer in the dist/accountfree/ folder. + - Run the `package-windows.bat` script (or `package-wine.sh`if you're cross-compiling on Linux). You will find a logarithmplotter-setup.exe installer in the dist/logarithmplotter/ folder. - MacOS Archive creator installer: - - You need `pyinstaller`. You can install it using `pip install pyinstaller`. - Run the `build-macosx.sh` script to build an .app for LogarithmPlotter which can be found in the dist directory. - - Run the `package-macosx.sh` script. You will find a LogarithmPlotter-v0.1-dev-setup.dmg installer in the dist/ folder. + - Run the `package-macosx.sh` script. You will find a LogarithmPlotter-v<version>-setup.dmg installer in the dist/ folder. - Linux packages: - - To build a DEB, you need DPKG and stdeb. You can install the later by using `pip install stdeb`. - To build and install the flatpak, you need [flatpak-builder](https://docs.flatpak.org/en/latest/flatpak-builder.html) installed. - To build the snap, you need [snapcraft](https://snapcraft.io) installed. - Run `package-linux.sh`. @@ -51,14 +48,15 @@ There are several ways to contribute to LogarithmPlotter. ## Tests -To run LogarithmPlotter's test, use the following: +To run LogarithmPlotter's tests, follow these steps: - Python - - Install `pytest` and `pytest-cov` - - Run `pytest --cov` + - Install python3 and [poetry](https://python-poetry.org/) + - Run `poetry install --with test` + - Run `scripts/run-tests.sh` ## Legal notice - LogarithmPlotter - 2D plotter software to make BODE plots, sequences and repartition functions. + LogarithmPlotter - 2D plotter software to make Bode plots, sequences and repartition functions. Copyright (C) 2021-2024 Ad5001 This program is free software: you can redistribute it and/or modify @@ -83,4 +81,4 @@ Language files translations located at LogarithmPlotter/i18n are licensed under LogarithmPlotter includes [expr-eval](https://github.com/silentmatt/expr-eval) a port of [ndef.parser](https://web.archive.org/web/20111023001618/http://www.undefined.ch/mparser/index.html) by Raphael Graf <r@undefined.ch>, ported to javascript by Matthew Crumley <email@matthewcrumley.com> (http://silentmatt.com/), and then to QMLJS by Ad5001. -The specific file (LogarithmPlotter/qml/eu/ad5001/LogarithmPlotter/js/expr-eval.js) is licensed under the [MIT License](https://raw.githubusercontent.com/silentmatt/expr-eval/master/LICENSE.txt). +The specific file (LogarithmPlotter/qml/eu/ad5001/LogarithmPlotter/js/lib/expr-eval/expr-eval.js) is licensed under the [MIT License](https://raw.githubusercontent.com/silentmatt/expr-eval/master/LICENSE.txt). diff --git a/poetry.lock b/poetry.lock index e2ba8cf..0c25a10 100644 --- a/poetry.lock +++ b/poetry.lock @@ -438,4 +438,4 @@ type = ["pytest-mypy"] [metadata] lock-version = "2.0" python-versions = ">=3.9,<3.13" -content-hash = "083111ed37f3ef23de75a56eaf4c6fdda954b6005c5ee0922aad4470e2a36738" +content-hash = "3db79d8b611fd2e37486fbd8e10c6d454b293cc7156d83b05c1a8459cb9b33e6" diff --git a/pyproject.toml b/pyproject.toml index a7aa8cc..f705e04 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -12,9 +12,11 @@ python = ">=3.9,<3.13" PySide6-Essentials = "^6.7.2" pyside6-addons = "^6.7.2" -[tool.poetry.group.dev.dependencies] +[tool.poetry.group.packaging.dependencies] pyinstaller = "^6.10.0" +stdeb = "^0.10.0" + +[tool.poetry.group.test.dependencies] pytest = "^8.3.3" pytest-cov = "^5.0.0" pytest-qt = "^4.4.0" -stdeb = "^0.10.0"