Skip to content

Refer to the API documentation #951

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 12, 2023
Merged

Refer to the API documentation #951

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 2 additions & 4 deletions docs/docs/use.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,7 @@
# Use
To use the bindings create a C# project and just add the corresponding [nuget packages](https://www.nuget.org/profiles/GirCore).

There are a lot of [sample projects](https://github.com/gircore/gir.core/tree/main/src/Samples) available which should get you started.

As long as there is no API documentation available you can refer to the [original documentation](https://developer.gnome.org/documentation/introduction/overview/libraries.html).
There are a lot of [sample projects](https://github.com/gircore/gir.core/tree/main/src/Samples) available to get you started. Extensive [API documentation](https://gircore.github.io/api/index.html) is provided and the [original documentation](https://developer.gnome.org/documentation/introduction/overview/libraries.html) can also be referenced.

The gir.core project is *not* providing the actual C libraries but only the C# bindings. Please ensure that the corresponding packages are installed on your system otherwise the binding will not find a target to bind to during runtime.

Expand All @@ -21,4 +19,4 @@ The easiest way to get started on Windows is by installing the packages through
1. Download msys2 from the [official website](https://www.msys2.org/).
2. Run `pacman -Syu` to update the package database.
3. Run `pacman -S mingw-w64-x86_64-XXX` to install a package named XXX.
4. Add the directory `C:/msys64/mingw64/bin` to the front of the PATH.
4. Add the directory `C:/msys64/mingw64/bin` to the front of the PATH.