Tutorials

Tutorials should teach by giving one clear outcome at a time.

This section is the beginning of that path for the family site. It is intended for readers who want a more guided route than the section overviews or cookbook pages provide.

How to use this section

Use the tutorial pages when you want:

• a clearer starting point

• a guided first run through one implementation or format

• a sequence with a specific outcome rather than a bag of examples

If you already know what task you want to solve, the cookbook pages may be a faster route.

Suggested reading order

For a broad introduction:

1. Family Tour

2. Choosing an Implementation

3. one of: * First Program in MakrellPy * First Program in MakrellTS * First Program in Makrell#

4. one of the format tutorials: * Use MRON for Configuration * Use MRML for Markup

For focused follow-up, use the implementation and format sections directly.

What is here

The current tutorial set includes:

• family-level orientation

• first-program tutorials for the main implementation tracks

• a pattern-matching tutorial

• interop and CLI workflow examples

• format-oriented tutorials for MRON and MRML

• Family Tour
  • One shared idea
  • Three quick glimpses
  • What this should suggest
  • Where to go next
• Choosing an Implementation
  • Choose MakrellPy
  • Choose MakrellTS
  • Choose Makrell#
  • Choose MRON or MRML
  • A simple rule of thumb
• First Program in MakrellPy
  • Install MakrellPy
  • Start the REPL
  • Try this program
  • What this does
  • Why this is a good first example
  • Next steps
• First Program in MakrellTS
  • Install the CLI
  • Try a small source file
  • Then try a tiny macro
  • What this shows
  • Next steps
• First Program in Makrell#
  • Run a source file
  • Try a small source file
  • Then try a small CLR interop example
  • What this shows
  • Next steps
• Pattern Matching Basics
  • Step 1: match a literal
  • Step 2: match structure
  • Step 3: match by type
  • Step 4: match regular sequence shape
  • Why this matters
  • Where to go next
• MakrellPy and Python Interop
  • Step 1: import from Python
  • Step 2: expose MakrellPy functions
  • Why this matters
  • Next steps
• Makrell# CLI Workflow
  • Step 1: run a source file
  • Step 2: build an assembly
  • Step 3: inspect generated C#
  • Step 4: parse MRON or MRML
  • Step 5: inspect replayable compile-time metadata
  • Why this matters
• Use MRON for Configuration
  • Step 1: write a small configuration
  • Step 2: add a list
  • Step 3: nest records
  • Why this is useful
• Use MRML for Markup
  • Step 1: write a small page
  • Step 2: add nested structure
  • Step 3: add attributes and inline nodes
  • Why this is useful
  • Next steps