diff options
| author | Adrien Hopkins <adrien.p.hopkins@gmail.com> | 2023-07-02 15:24:02 -0500 |
|---|---|---|
| committer | Adrien Hopkins <adrien.p.hopkins@gmail.com> | 2023-07-02 15:24:02 -0500 |
| commit | 85d07c240348e3a2ff85cedfc7aaef8126222a69 (patch) | |
| tree | 943a00b7e83374b7b8d40274f6a53e54b3d845ee | |
| parent | 028a3e9ae195239490f30c587899b249300408fe (diff) | |
Create roadmap for v1.0.0
| -rw-r--r-- | docs/roadmap.org | 27 |
1 files changed, 27 insertions, 0 deletions
diff --git a/docs/roadmap.org b/docs/roadmap.org new file mode 100644 index 0000000..2ff5ab5 --- /dev/null +++ b/docs/roadmap.org @@ -0,0 +1,27 @@ +* Version 1.0.0 Roadmap +Here is a list of the unfinished requirements for version 1.0.0. When everything here is met, I intend to release version 1.0.0 and consider 7Units complete (for the most part). + +These requirements are subject to change. I intend to finish version 1.0.0 by [2025-04-27 Sun]. + +Feature Requirements: +- 7Units should be able to parse unit files from [[https://www.gnu.org/software/units/][GNU Units]], the program that inspired it. + (It should not be required to handle features that aren't in 7Units; those definitions should be ignored with a warning) +- 7Units's expression converter should support most or all of the conversion features supported by GNU Units: + - Converting to sums of units (it should also be possible to do this in the unit converter with preset combinations) + - Non-integer exponents + - Fractions in unit expressions (like ~1|6~) + - (/Optional/) Inverse nonlinear conversion with the tilde prefix + - (/Optional/) Nonlinear units should be specifiable in unit files. + - /Any other feature not listed should be considered optional./ +- (/Optional/) It should be possible to add, edit and remove units and prefixes from the GUI unit and prefix viewers. + +Data/Configuration Requirements: +- All of the data formats (e.g. unit files) should be standardized. +- 7Units should put its configuration files in a standard place for the operating system ([[https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html][XDG Base Directory Specification]] compliant on Unix). The settings file should be able to specify the location of the data files. + +Documentation/Testing Requirements: +- 7Units should be fully documented. +- 7Units should have automated testing with a code coverage of at least 2/3 (ideally at least 5/6). + +Other Requirements +- The public API of 7Units should be finalized and well-designed. |