Skip to content

Commit 547872e

Browse files
authored
Merge pull request #9 from quickfix-j/copilot/add-documentation-for-code-generator
Add links to centralized documentation on quickfixj-pages
2 parents a0ce40f + 404be62 commit 547872e

1 file changed

Lines changed: 20 additions & 1 deletion

File tree

README.md

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,9 +60,28 @@ Or run the plugin goal directly:
6060
mvn quickfixj-codegenerator:generate
6161
```
6262

63+
## Documentation
64+
65+
For detailed usage instructions, configuration options, and examples, please refer to the comprehensive documentation:
66+
67+
- **[Message Code Generation Guide](https://quickfix-j.github.io/quickfixj-pages/docs/codegen)** - Complete guide covering:
68+
- Maven and Gradle project setup examples
69+
- Detailed configuration properties
70+
- Advanced customization with MessageCodeGenerator
71+
- Custom field and message definitions
72+
- XSLT template customization
73+
74+
- **[Customizing QuickFIX/J](https://github.com/quickfix-j/quickfixj/blob/master/customising-quickfixj.md)** - Advanced topics including:
75+
- BigDecimal usage for FIX decimal types
76+
- Managing incompatible data types across FIX versions
77+
- Custom Rules of Engagement
78+
- FIX Orchestra integration
79+
80+
- **[QuickFIX/J Messages Module](https://github.com/quickfix-j/quickfixj/blob/master/quickfixj-messages/readme.md)** - Build organization and custom build recommendations
81+
6382
## Configuration
6483

65-
Detailed configuration options can be specified in the `<configuration>` section of the plugin declaration. Refer to the plugin documentation for available parameters.
84+
Detailed configuration options can be specified in the `<configuration>` section of the plugin declaration. See the [Message Code Generation Guide](https://quickfix-j.github.io/quickfixj-pages/docs/codegen) for a complete list of available parameters and examples.
6685

6786
## Version Information
6887

0 commit comments

Comments
 (0)