Skip to content

Commit efc9fb9

Browse files
committed
Fix documentation links
- also slightly adapt Getting Started and contributing guides
1 parent 05a9ddb commit efc9fb9

File tree

3 files changed

+29
-29
lines changed

3 files changed

+29
-29
lines changed

CONTRIBUTING.md

+8-7
Original file line numberDiff line numberDiff line change
@@ -31,14 +31,15 @@ The preferred workflow for contributing code is to
3131
[fork](https://help.github.com/articles/fork-a-repo/) the [repository](https://github.com/svg-net/SVG) on GitHub, clone it,
3232
develop on a feature branch, and [create a pull request](https://help.github.com/articles/creating-a-pull-request-from-a-fork) when done.
3333
There are a few things to consider for contributing code:
34-
* Please use the same coding style as in the rest of the code
35-
* Use spaces instead of tabs
34+
* Please use the same coding style as in the rest of the code.
35+
* Use spaces instead of tabs.
3636
* Provide unit tests for bug fixes, or provide a test svg with a respective png counterpart showing the correct rendering
37-
(refer to existing test images for naming conventions)
38-
* Provide meaningful commit messages and/or PR comments
39-
* Check that the automatic tests on [AppVeyor](https://ci.appveyor.com/project/tebjan/svg) all pass for your pull request
40-
* Be ready to adapt your changes after a code review
41-
* When copying existing code from other sources or repositories, please keep licensing in mind
37+
(refer to existing test images for naming conventions).
38+
* Provide meaningful commit messages and/or PR comments. Normally, the commits will be squashed, but if you want to retain
39+
separate commits for separate parts of your feature, please edit the commit messages accordingly (rebasing the commits is ok).
40+
* Check that the automatic tests via [GitHub Actions](https://github.com/svg-net/SVG/actions) all pass for your pull request.
41+
* Be ready to adapt your changes after a code review.
42+
* When copying existing code from other sources or repositories, please keep licensing in mind.
4243

4344
### Contributing Documentation
4445

Docs/articles/Faq.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ This is currently a collection of answered questions in issues that have been cl
33
The format of the page is preliminary and may be changed, if more questions accumulate.
44

55
## 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.
77

88
## How to re-render an SVG faster?
99

Docs/articles/GettingStarted.md

+20-21
Original file line numberDiff line numberDiff line change
@@ -5,25 +5,24 @@
55
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.
66

77
### 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)
99
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.
1111
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.
1413

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.
1615
If you are already using version `2.4` or use other libraries depending on the `2.4` versions you can also upgrade,
1716
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.
1918
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.
2120

2221
### Installing via NuGet
2322
The library is available as a NuGet package in the public NuGet feed (https://www.nuget.org/packages/Svg/).
2423
Depending on your development stack you can add it to your code base.
2524

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:
2726
```
2827
Install-Package Svg
2928
```
@@ -44,14 +43,14 @@ Once you downloaded the sources you can use the IDE of your choice to open the s
4443
and use your IDE to compile the version you would like to have.
4544

4645
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:
4847
```
49-
dotnet build -c release -f netcoreapp3.1 Svg.csproj
48+
dotnet build -c release -f net8.0 Svg.csproj
5049
```
51-
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.
5251

5352
## 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.
5554
.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.
5655
This is not included in the packages by default, since this would break rendering on Windows systems.
5756

@@ -66,16 +65,16 @@ sudo apt-get update
6665
sudo apt-get install -y libgdiplus
6766
```
6867

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.
7170
This package can be included in the SVG component if you roll your own version from source.
7271
This can be achieved by altering the `Svg.csproj` file and un-comment the following block of code:
7372
```
74-
<!--
75-
<ItemGroup Condition="'$(TargetFramework)' == 'netcoreapp3.1'">
76-
<PackageReference Include="runtime.osx.10.10-x64.CoreCompat.System.Drawing" Version="5.8.64" />
77-
</ItemGroup>
78-
-->
73+
<ItemGroup Condition="'$(TargetFramework)' == 'netstandard2.0'">
74+
...
75+
<!-- Mac specific include -->
76+
<PackageReference Include="runtime.osx.10.10-x64.CoreCompat.System.Drawing" Version="5.8.64" />
77+
</ItemGroup>
7978
```
8079
This will link the `CoreCompat` package in the project.
8180
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
104103
However, please keep in mind that the Mac and Linux versions require additional tooling/packages.
105104

106105
## 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.
108107

109108
## 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).
111110
If the Q&A does not solve your problem, please open a ticket with your request.

0 commit comments

Comments
 (0)