You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: Docs/articles/Faq.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -3,7 +3,7 @@ This is currently a collection of answered questions in issues that have been cl
3
3
The format of the page is preliminary and may be changed, if more questions accumulate.
4
4
5
5
## How to get started
6
-
Please use our [getting started article](http://svg-net.github.io/SVG/doc/GettingStarted.html) to get started with installation and implementation of the SVG library.
6
+
Please use our [getting started article](http://svg-net.github.io/SVG/articles/GettingStarted.html) to get started with installation and implementation of the SVG library.
Copy file name to clipboardExpand all lines: Docs/articles/GettingStarted.md
+20-21
Original file line number
Diff line number
Diff line change
@@ -5,25 +5,24 @@
5
5
Depending on the way you want to work with the library you can get the SVG library via NuGet, or roll your own binary from the sources or a personal fork of the sources.
6
6
7
7
### Which version to choose?
8
-
There are 2 major supported versions at the moment: version `2.4.*` and version `3.0.*`. Version `2.4.*` is a .NET Framework specific version (non .NET Core compatible)
8
+
There are 2 major supported versions at the moment: version `2.4.*` and version `3.x`. Version `2.4.*` is a .NET Framework specific version (non .NET Core compatible)
9
9
which can be considered rather stable for use within a .NET project.
10
-
The `3.0` version is a more recent version with added .NET Core compatibility and the possibility to run the package in .NET Core projects under Windows, Linux and MacOs.
10
+
The `3.0` version is a more recent version with added .NET Core compatibility and the possibility to run the package in .NET Core projects under Windows, Linux and macOS.
11
11
The .NET framework compatibility is also maintained, which allows you to use the package in the regular .NET framework (version 3.5 and above).
12
-
The `3.0` version also contains some bugfixes which are not (yet) in the `2.4` version,
13
-
but this is a limited set and if required these fixes can be merged into the `2.4` version on request.
12
+
The `3.x` versions also contain some bugfixes which are not in the `2.4` version, and if required some of these fixes can be merged into the `2.4` version.
14
13
15
-
If you are going to use the package for the first time, your best bet is to go for the `3.0.*` version - this allows for maximum flexibility and portability.
14
+
If you are going to use the package for the first time, your best bet is to go for the latest `3.x` version - this allows for maximum flexibility and portability.
16
15
If you are already using version `2.4` or use other libraries depending on the `2.4` versions you can also upgrade,
17
16
but there is a possibility that you might encounter compatibility issues/errors.
18
-
The library is unit tested, but it cannot be guaranteed that versions `3.0` and `2.4` behave completely the same.
17
+
The library is unit tested, but it cannot be guaranteed that versions `3.x` and `2.4` behave completely the same.
19
18
If you are working with the .NET framework version you are likely to encounter no big issues, but if you switch to the .NET Core version or switch platforms
20
-
(e.g. to MacOs or Linux) you need to test and validate the calling code to be sure everything keeps working as expected.
19
+
(e.g. to macOS or Linux) you need to test and validate the calling code to be sure everything keeps working as expected.
21
20
22
21
### Installing via NuGet
23
22
The library is available as a NuGet package in the public NuGet feed (https://www.nuget.org/packages/Svg/).
24
23
Depending on your development stack you can add it to your code base.
25
24
26
-
For Visual Studio 2013 - 2019 you can add it by searching it in the NuGet wizard or by using the following command in the NuGet Console:
25
+
In Visual Studio you can add it by searching it in the NuGet wizard or by using the following command in the NuGet Console:
27
26
```
28
27
Install-Package Svg
29
28
```
@@ -44,14 +43,14 @@ Once you downloaded the sources you can use the IDE of your choice to open the s
44
43
and use your IDE to compile the version you would like to have.
45
44
46
45
If you would like to use `dotnet-cli` to build the sources you can use the following command in the `Sources/` folder to build the library
47
-
for .NET Core 3.1 with the compiler setting for release:
46
+
for example for .NET 8.0 with the compiler setting for release:
This will put the output into the `bin/Release/netcoreapp3.1/` folder.
50
+
This will put the output into the `bin/Release/net8.0/` folder.
52
51
53
52
## Special instructions for Mac and Linux
54
-
The library depends on GDI+ (see also [here](http://svg-net.github.io/SVG/doc/Q&A.html#im-getting-a-svggdipluscannotbeloadedexception-if-running-under-linux-or-macos)) for rendering.
53
+
The library depends on GDI+ (see also [here](http://svg-net.github.io/SVG/articles/Faq.html#im-getting-a-svggdipluscannotbeloadedexception-if-running-under-linux-or-macos)) for rendering.
55
54
.NET Core does not support GDI+ out of the box for non-Windows systems. For Mac and Linux you need to add a special compatibility package.
56
55
This is not included in the packages by default, since this would break rendering on Windows systems.
57
56
@@ -66,16 +65,16 @@ sudo apt-get update
66
65
sudo apt-get install -y libgdiplus
67
66
```
68
67
69
-
### MacOs
70
-
MacOs does not require you to install a system-wide package, but allows you to use a compatibility package that is included in the application.
68
+
### macOS
69
+
macOS does not require you to install a system-wide package, but allows you to use a compatibility package that is included in the application.
71
70
This package can be included in the SVG component if you roll your own version from source.
72
71
This can be achieved by altering the `Svg.csproj` file and un-comment the following block of code:
This will link the `CoreCompat` package in the project.
81
80
If you make a project reference to `Svg.csproj` the consuming application/library will automatically also include the `CoreCompat` package.
@@ -104,8 +103,8 @@ The Svg library does not utilize other external references under Windows, and by
104
103
However, please keep in mind that the Mac and Linux versions require additional tooling/packages.
105
104
106
105
## Using the library (examples)
107
-
This part will be extended in the future, for now please refer to the [Q&A](http://svg-net.github.io/SVG/doc/Q&A.html) for examples of how to use the library.
106
+
This part will be extended in the future, for now please refer to the [Q&A](http://svg-net.github.io/SVG/articles/Faq.html) for examples of how to use the library.
108
107
109
108
## Troubleshooting
110
-
If you encounter any problems or difficulties, please refer to the [Q&A part of the documentation](http://svg-net.github.io/SVG/doc/Q&A.html).
109
+
If you encounter any problems or difficulties, please refer to the [Q&A part of the documentation](http://svg-net.github.io/SVG/articles/Faq.html).
111
110
If the Q&A does not solve your problem, please open a ticket with your request.
0 commit comments