ryujinx-archive/GtkSharp
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Initial commit of README, plus copy out the LICENSE from gtk-sharp

Browse source
This commit is contained in:
cra0zy 2017-10-30 14:35:00 +01:00
parent 4bc1fb5101
commit 75f0602992
2 changed files with 46 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
LICENSE
View file

@ -477,4 +477,4 @@ necessary. Here is a sample; alter the names:
<signature of Ty Coon>, 1 April 1990
Ty Coon, President of Vice
That's all there is to it!
That's all there is to it!

45
README.md Executable file
View file

@ -0,0 +1,45 @@
# GtkSharp
GtkSharp is a C# wrapper for Gtk and its related components. The component list includes the following libraries: glib, gio, cairo, pango, atk, gdk.
* [Building from source](#building-from-source)
* [Using the library](#using-the-library)
* [License](#license)
## Building from source
Pre requirements for building from source are that you have .Net Core and msbuild installed on the system.
To build the repository, first clone it:
```sh
git clone https://github.com/cra0zy/GtkSharp.git
cd GtkSharp
```
and then simply run either `.\build.ps1` or `./build.sh` depending your operating system.
If you wish to generate the nuget packages simply add the `--BuildTarget=PackageNuGet` as an argument when calling the build script.
A breakdown on how the source is structured:
* Tools that are needed to generate wrapper code are found in [Tools](Source/Tools) folder
* The actual wrappers code is found in [Libs](Source/Libs) folder
* Templates are located in [Templates](Source/Templates) folder
* Build script is separated between [build.cake](build.cake) and [CakeScripts](CakeScripts) folder
## Using the library
On both Windows and Linux the library assumes that you have Gtk installed on your system. See [Installing Gtk on Windows](https://github.com/cra0zy/GtkSharp/wiki/Installing-Gtk-on-Windows) wiki page for more details on how to do it on Windows.
To create a new gtk app project, simply use `dotnet new` templating engine:
* install: `dotnet new --install GtkSharp.Template.CSharp`
* uninstall: `dotnet new --uninstall GtkSharp.Template.CSharp`
* generate project: `dotnet new gtkapp`
Visual Studio and MonoDevelop addins will be available in the coming weeks.
## License
GtkSharp and its related components are licensed under LGPL v2.1 license, see [LICENSE](LICENSE) for more details.