Updated the Readme.md with to be compatible with the current code

vandeseer / easytable

Small table drawing library built upon Apache PDFBox

MIT License

246 stars 94 forks source link

Updated the Readme.md with to be compatible with the current code #15

Closed wapolinar closed 5 years ago

wapolinar commented 5 years ago

Code changes because of lombok integration
Added separate example file for Readme.md example
- Ensures that the example is built separately (imports, etc.)

wapolinar commented 5 years ago

The Readme.md has some small errors, because with the introduction of lombok, the TableDrawer Syntax changed. Also, the colors are not accessible, because they are part of the integration tests.

To resolve this issue, I created a this PR that runs the Readme.md example in a separate file. It would be great to just do an include of the lines into the Readme.md, but this is apparently not possible.

vandeseer commented 5 years ago

I like the idea to extract the code into a file of its own. Also I agree that it would be nice to just include it in the README directly (it is cumbersome to always copy it). Maybe this could be done by a git hook so that before every commit the contents or part of the contents of the extracted file is/are replaced in the README.

I will have a look in the next days.

vandeseer commented 5 years ago

Will merge this now, but I think I will replace the actual code in the README with the link to the extracted file at one point – the duplicated stuff is otherwise hard to maintain (keeping in sync).