Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
rafageist committed Aug 16, 2024
1 parent 084b4cc commit 8558bc2
Showing 1 changed file with 5 additions and 11 deletions.
16 changes: 5 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,18 +12,13 @@ The Div CSharp Mapper Generator is a powerful tool designed to automate the crea

## Getting Started

### Prerequisites

- .NET SDK (version 7.0 or later)
- A project with the classes you wish to map

### Installation

You can either compile the Div CSharp Mapper Generator from source or download the precompiled binary from the GitHub releases page.

## Usage
### Usage

### 1. Create a JSON Configuration File
#### 1. Create a JSON Configuration File

Create a mapper.json file in the root of your project. This file defines the mappings you wish to generate.

Expand All @@ -48,7 +43,7 @@ Create a mapper.json file in the root of your project. This file defines the map
- `outputFolder`: The directory where the generated mapper file will be placed.
- `classPairs`: An array of class pairs to map. Identical class pairs will generate a cloning method.

### 2. Run the Mapper Generator
#### 2. Run the Mapper Generator

Execute the following command from the root of your project:

Expand All @@ -58,11 +53,11 @@ path/to/div-cs-mapper-generator.exe path/to/mapper.json

This command will generate the mapping classes based on the configuration provided in mapper.json.

### 3. Locate the Generated Files
#### 3. Locate the Generated Files

The generated files will be found in the output folder specified in the JSON configuration.

## Extends and customization
### Extends and customization

You can inherit the generated mapper class to override the generated methods or add new ones.

Expand All @@ -86,4 +81,3 @@ namespace Namespace.Of.Your.Mapper
## Documentation

Visit [https://divengine.org](https://divengine.org)

0 comments on commit 8558bc2

Please sign in to comment.