Generation Modes
Different ways to generate README files with qmims
qmims supports three different modes for generating README files, each offering different levels of control and automation.
Auto Mode
Fully Automatic
AI analyzes your project and generates a complete README
Template Mode
Structured
Uses predefined templates with AI-generated content
Instruct Mode
Precise Control
Uses embedded instructions for targeted content generation
Auto Mode
Auto mode analyzes your project structure, code, and dependencies to generate a comprehensive README file automatically.
qmims generate --mode auto
In auto mode, qmims will:
- Analyze your project structure and files
- Identify the programming language(s) and frameworks used
- Detect dependencies and their versions
- Infer the project's purpose and main features
- Generate a README with appropriate sections based on this analysis
Auto mode is ideal for quickly generating a comprehensive README for a new project or updating documentation for an existing project.
Choosing the Right Mode
Use Auto Mode when:
- You need a quick, comprehensive README
- You're starting a new project
- You want a complete analysis of your project
Use Template Mode when:
- You want a specific structure for your README
- You need consistency across multiple projects
- You want to use a custom template
Use Instruct Mode when:
- You need precise control over specific sections
- You want to update only parts of an existing README
- You have specific requirements for certain sections