43 lines (33 loc) · 1.74 KB

DEVELOPMENT

This project is developed by using various developer tools. For runtime dependencies see BUILD subsection.

GIT SCM/VCS
IDE/Editor: Neovim, Vim, KDE Kate, VS Code etc.
System: Linux-based, e.g. Debian (U/Kubuntu) or alike
Shell: zsh or bash
others...

GIT WORKLOW & CONVENTIONS

This project's history is going to be aggressively force-pushed and squash-rebased into a specific semver versions
The said versions might be later revised, dropped or removed (unless specific package manager doesn't allow version replacement).
This implies that any upstream commits pulled may become obsolete

Tags naming conventions:

latest - latest released version
vX.Y.Z - version, per semver
nighlty - testing build

Branch naming convention

main - main dev branch
release/X.Y.Z - next release; tightly coupled to main

BUILD

Dev dependencies

GNU Make - required for make command; should be already installed on *nix systems
ts-vimdoc - the tool is used to generate doc/*.txt files from *.md
LuaFormatter - lua code formatter; much faster than stylua

Runtime dependencies

September 28, 2023
Copyright © 2023 - Alexander Davronov, et.al.