🛠️ Development Setup

1. Clone the repository

   git clone https://github.com/benfalk/req_md.git
   

2. Setup local development environment

   • If you have just installed:

   just dev-setup
   

   • If you don’t have just installed (installs just as well):

   ./scripts/setup-dev-env.sh
   

3. Available Justfile Recipes

   default                # lists all recipes
   menu                   # launch interactive menu
   
   [build]
   build                  # Builds all crates in the workspace
   build-install-cli      # Installs the CLI reqmd
   build-install-tui      # Installs experimental TUI reqmd_tui
   build-rust-docs        # Builds and opens rust crate documentation
   
   [dev]
   dev-book               # mdbook documentation with hot reloading
   dev-cli COMMAND *ARGS  # Runs dev CLI, rebuilding when needed
   dev-setup              # Setup environment for development
   dev-tui *ARGS          # Runs dev TUI, rebuilding when needed
   
   [test]
   test *TEST_CASES       # runs quick tests or specific functions
   test-all               # runs all tests, including publish checks
   test-doc-gen           # souce comments documentation
   test-docs              # runs code comment examples as tests
   test-format            # ensures code is formatted correctly
   test-funcs *TEST_CASES # run all or specific tests functions
   test-publish           # checks crates are ready for crates.io
   test-short             # runs quick tests for development