Skip to content

Commit 4d8dea0

Browse files
authored
Merge pull request ststeiger#266 from MichelMichels/readme-update
Readme update
2 parents 9b04f79 + 9146b11 commit 4d8dea0

File tree

6 files changed

+33
-25
lines changed

6 files changed

+33
-25
lines changed

LICENCE.md renamed to LICENSE.md

File renamed without changes.

MigraDocCore.DocumentObjectModel/MigraDocCore.DocumentObjectModel.csproj

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<Authors>Stefan Steiger and Contributors</Authors>
66
<Description>MigraDocCore.DocumentObjectModel for .NET Core MigraDocCore.DocumentObjectModel was ported from MigraDoc version 1.32</Description>
77
<Copyright>Copyright (c) 2005-2007 empira Software GmbH, Cologne (Germany)</Copyright>
8-
<PackageLicenseFile>LICENCE.md</PackageLicenseFile>
8+
<PackageLicenseFile>LICENSE.md</PackageLicenseFile>
99
<PackageProjectUrl>https://github.com/ststeiger/PdfSharpCore</PackageProjectUrl>
1010
<RepositoryUrl>https://github.com/ststeiger/PdfSharpCore</RepositoryUrl>
1111
<PackageReleaseNotes>MigraDocCore.DocumentObjectModel was ported from MigraDoc version 1.32</PackageReleaseNotes>
@@ -27,7 +27,7 @@
2727
</ItemGroup>
2828

2929
<ItemGroup>
30-
<None Include="..\LICENCE.md" Pack="true" PackagePath="" />
30+
<None Include="..\LICENSE.md" Pack="true" PackagePath="" />
3131
</ItemGroup>
3232

3333
</Project>

MigraDocCore.Rendering/MigraDocCore.Rendering.csproj

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77

88
MigraDocCore.Rendering was ported from MigraDoc version 1.32</Description>
99
<Copyright>Copyright (c) 2005-2007 empira Software GmbH, Cologne (Germany)</Copyright>
10-
<PackageLicenseFile>LICENCE.md</PackageLicenseFile>
10+
<PackageLicenseFile>LICENSE.md</PackageLicenseFile>
1111
<PackageProjectUrl>https://github.com/ststeiger/PdfSharpCore</PackageProjectUrl>
1212
<RepositoryUrl>https://github.com/ststeiger/PdfSharpCore</RepositoryUrl>
1313
<PackageReleaseNotes>MigraDocCore.Rendering was ported from MigraDoc version 1.32</PackageReleaseNotes>
@@ -31,7 +31,7 @@ MigraDocCore.Rendering was ported from MigraDoc version 1.32</Description>
3131
</ItemGroup>
3232

3333
<ItemGroup>
34-
<None Include="..\LICENCE.md" Pack="true" PackagePath="" />
34+
<None Include="..\LICENSE.md" Pack="true" PackagePath="" />
3535
</ItemGroup>
3636

3737
</Project>

PdfSharpCore.Charting/PdfSharpCore.Charting.csproj

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<Authors>Stefan Steiger and Contributors</Authors>
66
<Description>PdfSharpCore.Charting for .NET Core PdfSharpCore.Charting was ported from PdfSharp</Description>
77
<Copyright>Copyright (c) 2005-2007 empira Software GmbH, Cologne (Germany)</Copyright>
8-
<PackageLicenseFile>LICENCE.md</PackageLicenseFile>
8+
<PackageLicenseFile>LICENSE.md</PackageLicenseFile>
99
<PackageProjectUrl>https://github.com/ststeiger/PdfSharpCore</PackageProjectUrl>
1010
<RepositoryUrl>https://github.com/ststeiger/PdfSharpCore</RepositoryUrl>
1111
<PackageReleaseNotes>PdfSharpCore.Charting was ported from PdfSharp</PackageReleaseNotes>
@@ -26,7 +26,7 @@
2626
</ItemGroup>
2727

2828
<ItemGroup>
29-
<None Include="..\LICENCE.md" Pack="true" PackagePath="" />
29+
<None Include="..\LICENSE.md" Pack="true" PackagePath="" />
3030
</ItemGroup>
3131

3232
</Project>

PdfSharpCore/PdfSharpCore.csproj

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
PdfSharpCore is a partial port of PdfSharp.Xamarin for .NET Core Additionally MigraDoc has been ported as well (from version 1.32). Images have been implemented with ImageSharp from https://www.nuget.org/packages/SixLabors.ImageSharp</Description>
1010
<Copyright>Copyright (c) 2005-2007 empira Software GmbH, Cologne (Germany)</Copyright>
11-
<PackageLicenseFile>LICENCE.md</PackageLicenseFile>
11+
<PackageLicenseFile>LICENSE.md</PackageLicenseFile>
1212
<PackageProjectUrl>https://github.com/ststeiger/PdfSharpCore</PackageProjectUrl>
1313
<RepositoryUrl>https://github.com/ststeiger/PdfSharpCore</RepositoryUrl>
1414
<PackageReleaseNotes>PdfSharpCore is a partial port of PdfSharp.Xamarin for .NET Core Additionally MigraDoc has been ported as well (from version 1.32)</PackageReleaseNotes>
@@ -49,7 +49,7 @@ PdfSharpCore is a partial port of PdfSharp.Xamarin for .NET Core Additionally Mi
4949
</ItemGroup>
5050

5151
<ItemGroup>
52-
<None Include="..\LICENCE.md" Pack="true" PackagePath="" />
52+
<None Include="..\LICENSE.md" Pack="true" PackagePath="" />
5353
</ItemGroup>
5454

5555
</Project>

README.md

Lines changed: 25 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -19,23 +19,31 @@ Image support has been implemented with [SixLabors.ImageSharp](https://github.co
1919

2020
## Example
2121

22-
```cs
23-
static void Main(string[] args)
24-
{
25-
var document = new PdfDocument();
26-
var page = document.AddPage();
27-
var gfx = XGraphics.FromPdfPage(page);
28-
var font = new XFont("OpenSans", 20, XFontStyle.Bold);
29-
30-
gfx.DrawString(
31-
"Hello World!", font, XBrushes.Black,
32-
new XRect(20, 20, page.Width, page.Height),
33-
XStringFormats.Center);
34-
35-
document.Save("test.pdf");
36-
}
37-
```
22+
The following code snippet creates a simple PDF-file with the text 'Hello World!'.
23+
The code is written for a .NET 6 console app with top level statements.
24+
25+
```csharp
26+
using PdfSharpCore.Drawing;
27+
using PdfSharpCore.Fonts;
28+
using PdfSharpCore.Pdf;
29+
using PdfSharpCore.Utils;
30+
31+
GlobalFontSettings.FontResolver = new FontResolver();
32+
33+
var document = new PdfDocument();
34+
var page = document.AddPage();
3835

36+
var gfx = XGraphics.FromPdfPage(page);
37+
var font = new XFont("Arial", 20, XFontStyle.Bold);
38+
39+
var textColor = XBrushes.Black;
40+
var layout = new XRect(20, 20, page.Width, page.Height);
41+
var format = XStringFormats.Center;
42+
43+
gfx.DrawString("Hello World!", font, textColor, layout, format);
44+
45+
document.Save("helloworld.pdf");
46+
```
3947

4048
## Contributing
4149

@@ -44,4 +52,4 @@ We appreciate feedback and contribution to this repo!
4452

4553
## License
4654

47-
This software is released under the MIT License. See the [LICENSE](LICENCE.md) file for more info.
55+
This software is released under the MIT License. See the [LICENSE](LICENCE.md) file for more info.

0 commit comments

Comments
 (0)