Contributing to Docrunner

If you would like to contribute to docrunner please follow these instructions to set a local development environment up

Prerequisities: Install the Dart Language SDK on your local system

Fork this repository
Clone your fork of this repository
Base all of your development of the dev branch
Run this command in the root directory to install the necessary packages for the project:

dart pub get

Run this command in the root directory to generate all necessary dart code:

dart run build_runner build

To run the cli tool in development, run:

dart run bin/main.dart

You're all set! You can now edit source code within the bin and lib directories
(Optional) If you want to build and test a custom self-contained executable for the project, you can run:

dart compile exe bin/main.dart

This will create binary file named main in the bin folder

For larger changes like adding support for another language, please open an issue here