Home

Welcome to the writeme wiki!

Converter:

Responsible for parsing and extracting information from various sources like the configuration file, Git repository, and scanned files. Each information source (e.g., config file, method to scan .git folder, license search) has a corresponding method that returns a ConverterOutput struct containing the extracted data.

ConverterOutput: A struct that represents the transformed information obtained from each information source. For each config file or method used to gather information, a separate instance of ConverterOutput is created, encapsulating the specific data obtained.

Merger:

A module that handles the merging of multiple instances of ConverterOutput. It provides a user interface or decision-making mechanism to select and merge specific information from different ConverterOutput instances. The merged information is passed on for further processing.

Assembler:

A module responsible for generating the final README file based on the merged information. It takes the merged data as input and uses it to construct the desired README file structure. The Assembler utilizes the merged information to create the sections and content for the README file.

This architecture and logic flow allows for a modular design where each component performs a specific task, and the data is passed from one stage to another in a structured manner. The ConverterOutput struct serves as an intermediate representation for each source of information, which is then merged using the Merger module. Finally, the Assembler module takes the merged information to generate the README file.