steno

steno is a personal project to digitize my stenographic writings.

Description

Archtecture

Getting Started

Linux, MacOS, and Windows (WSL2)

1. Install
   • direnv
   • nix (https://nixos.org/download/#nix-install-linux)
2. Create an .envrc.local file (see .envrc.local.example).
3. In the project folder run:

   direnv allow
       

   first time it will be a long process to download all packages and libraries.

Windows (non WSL2)

1. Install
   • python 3.12+
   • uv (https://docs.astral.sh/uv/getting-started/installation/)
   • babashka
   • cljstyle
   • kondo
2. Create manually the user variables defined in .envrc.local.example.
3. In the project folder run:

   uv venv
   uv sync
       

Development

To format the code run:

bb format

To lint the code run:

bb kondo

To make sure that no unformatted commits with lint errors end up in the main branch run initially:

	git config core.hooksPath hooks

The pre-push script will block the push if there are style or lint errors in code.

License

This project is released under the GNU General Public License. See the file for details.