Skip to content

Commit e3bc153

Browse files
committed
Amended docs and package description.
1 parent f8dfc47 commit e3bc153

File tree

6 files changed

+430
-1024
lines changed

6 files changed

+430
-1024
lines changed

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,3 +23,6 @@ doc/api/
2323
# Workspace settings
2424
*.code-workspace
2525
.vscode
26+
27+
# Local images
28+
images/.images

CHANGELOG.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
11

2+
## 0.3.1
3+
- Amended docs and package description.
4+
25
## 0.3.0
36
* Breaking changes:
47
- Removed class `SyntheticInput` and replaced it with the enum

README.md

Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -102,13 +102,7 @@ A sample `build.yaml` file is shown below.
102102
# dart run build_runner build --delete-conflicting-outputs --verbose
103103
```
104104

105-
## Implementation Details
106-
107-
The classes [`MergingBuilder`][class-merging-builder]
108-
and [`StandaloneBuilder`][class-standalone-builder]
109-
use *synthetic input*.
110-
111-
### Merging Builder
105+
# Merging Builder
112106

113107
[`MergingBuilder`][MergingBuilder] reads *several input files* and writes merged output to *one output file*.
114108
The builder provides the option to sort the input files in reverse topological order.
@@ -124,7 +118,7 @@ The figure below shows the flow of data between the builder and the generator. T
124118

125119
![Directed Graph Image](https://raw.githubusercontent.com/simphotonics/merging_builder/master/images/merging_builder.svg?sanitize=true)
126120

127-
### Class - Standalone Builder
121+
## Standalone Builder
128122

129123
[`StandaloneBuilder`][StandaloneBuilder] reads input files and writes
130124
corresponding output files to a custom location.
@@ -137,6 +131,7 @@ Output files are specified by using the custom symbol
137131

138132
Limitations: For builders extending [`StandaloneBuilder`][StandaloneBuilder] it is recommended to initiate the build command
139133
from the root directory of the package the build is applied to.
134+
140135
## Examples
141136

142137
For further information on how to use [`MergingBuilder`][MergingBuilder] see [example].

0 commit comments

Comments
 (0)