From 47685fde8c9c59b25dfc073c9101c15b0ee5a972 Mon Sep 17 00:00:00 2001 From: Jennifer Taylor Date: Sun, 4 Jul 2021 15:55:54 +0000 Subject: [PATCH] Update readme with typing/flake notes and fix setup.py typing issue. --- README.md | 14 ++++++++++++++ setup.py | 2 +- 2 files changed, 15 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index a50d2d9..b756429 100644 --- a/README.md +++ b/README.md @@ -58,3 +58,17 @@ A patch with multiple offsets, and helpful author descriptions for each section: Utility for combining/splitting/byteswapping ROM files. Run it like `./splitrom --help` to see generic help and what commands are available, and like `./splitrom --help` for a specific command's help. + +## Developing + +The tools here are fully typed, and should be kept that way. To verify type hints, run the following: + +``` +mypy --strict . +``` + +The tools are also lint clean (save for line length lints which are useless drivel). To verify lint, run the following: + +``` +flake8 --ignore E501 . +``` diff --git a/setup.py b/setup.py index 9cbe37b..6441088 100644 --- a/setup.py +++ b/setup.py @@ -1,4 +1,4 @@ -from setuptools import setup +from setuptools import setup # type: ignore setup(