Skip to content

readme: Add implementation tutorial and reference links#4

Merged
NickVolynkin merged 1 commit into25.2.3+from
rework-project-and-readme
Mar 16, 2026
Merged

readme: Add implementation tutorial and reference links#4
NickVolynkin merged 1 commit into25.2.3+from
rework-project-and-readme

Conversation

@NickVolynkin
Copy link
Contributor

@NickVolynkin NickVolynkin commented Mar 9, 2026

@NickVolynkin NickVolynkin force-pushed the rework-project-and-readme branch 29 times, most recently from b917f35 to 37254f8 Compare March 11, 2026 09:52
@NickVolynkin NickVolynkin force-pushed the rework-project-and-readme branch 4 times, most recently from f186d1d to bffee08 Compare March 11, 2026 15:03
DataModule1.mdLayouts.Post;
end;

// Event that is called when the application starts
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
// Event that is called when the application starts
// The event raised at application startup

end;


// Event that is called when a user saves a report layout in the Report Designer
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In most cases, we can just throw away "that is" without any losses. In general, the fewer words we have, the better.

Suggested change
// Event that is called when a user saves a report layout in the Report Designer
// The event raised when a user saves a report layout in the "Report Designer"

@NickVolynkin NickVolynkin force-pushed the rework-project-and-readme branch 4 times, most recently from 8643433 to 499693e Compare March 13, 2026 16:42
README.md Outdated
1. Click **Design Report** to display the [Report Designer][dx-report-designer] dialog.
1. Create a report layout using tools available within the UI.
2. Click the hamburger button, select the **Save** option, and close the dialog.
2. Close the app. The [TdxMemData] component will store layout data in the [data.dat] file between sessions.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Abadzhev JFYI: The [TdxMemData] style links are resolved in the same way as [TdxMemData][TdxMemData] or [TdxMemData](https://...). I'm using this minimalist style exclusively for API reference links and files.

README.md Outdated
The example uses a memory-based dataset
([TdxMemData] inherited from the [TDataSet] class shipped with the standard VCL library).
Applications in this example encapsulate data components within separate data modules:
[uData.pas] (Delphi) and [uData.cpp] (C++Builder).
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The space is not an error, this line is intended to look like this way:

... data modules: uData.pas (Delphi) and uData.cpp (C++Builder)

@NickVolynkin NickVolynkin force-pushed the rework-project-and-readme branch from f0e7d24 to 9ceaec5 Compare March 16, 2026 08:24
@NickVolynkin NickVolynkin force-pushed the rework-project-and-readme branch from bbde2c3 to b1454f5 Compare March 16, 2026 12:16
@NickVolynkin NickVolynkin changed the title Rework projects and the readme Readme: Add implementation tutorial and reference links Mar 16, 2026
@NickVolynkin NickVolynkin force-pushed the rework-project-and-readme branch from b1454f5 to e874c26 Compare March 16, 2026 12:36
@NickVolynkin NickVolynkin changed the title Readme: Add implementation tutorial and reference links readme: Add implementation tutorial and reference links Mar 16, 2026
- Add a step-by-step instruction with screenshots
- Add more reference links to DevExpress and standard VCL library
- Update repository description, link, and tags

Co-authored-by: Dmitry Eliseev <dmitry.eliseev@devexpress.com>
Co-authored-by: Vladimir Abadzhev <vladimira@devexpress.com>
Co-authored-by: Ilia Nenashev <ilia.nenashev@devexpress.com>
@NickVolynkin NickVolynkin force-pushed the rework-project-and-readme branch from 8df7bf0 to 5c16a84 Compare March 16, 2026 13:36
@NickVolynkin NickVolynkin merged commit ae5a71e into 25.2.3+ Mar 16, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants