Req - Requirements engineering without the frills

Version

Req is a deliberately ultra-minimalist requirement management tool.

It is inspired by tagref and adds the notions of requirement sets and relations.

Note

Full documentation: doc/req.md

I wrote several tools (e.g. yreq) to deal with requirements. req is an attempt to replace tagref in the process described in Simplify your project documentation: Markdown + forge, that's all you need.

Support

If you like req (or LuaX) and are willing to support its development, please consider donating:

Installation

req requires LuaX.

# install req in ~/.local/bin and ~/.local/lib
$ git clone https://codeberg.org/cdsoft/req
$ cd req
$ bang && ninja install

or set $PREFIX to install req to a custom directory ($PREFIX/bin and $PREFIX/lib):

$ export PREFIX=/path # install req to /path/bin and /path/lib
$ git clone https://codeberg.org/cdsoft/req
$ cd req
$ bang && ninja install

This will install 2 files in $PREFIX/bin:

$PREFIX/bin/req: req command line utility compiled with LuaX. It can be run without any dependency.
$PREFIX/bin/req.lua: req.lua command line utility bundled with LuaX as a standalone Lua script. It requires a Lua 5.4 or 5.5 interpreter (e.g.: lua).

In case precompiled binaries are needed (GNU/Linux, MacOS, Windows), some can be found at cdelord.fr/pub. These archives contain req as well as some other softwares more or less related to LuaX.

Documentation

The full documentation is here: doc/req.md.

License

req is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

req is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with req.  If not, see <https://www.gnu.org/licenses/>.

For further information about req you can visit
https://codeberg.org/cdsoft/req