diff --git a/LICENSE b/LICENSE index f40e25aeb..6c5ec3647 100755 --- a/LICENSE +++ b/LICENSE @@ -477,4 +477,4 @@ necessary. Here is a sample; alter the names: , 1 April 1990 Ty Coon, President of Vice -That's all there is to it! +That's all there is to it! \ No newline at end of file diff --git a/README.md b/README.md new file mode 100755 index 000000000..2ed546eaa --- /dev/null +++ b/README.md @@ -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. \ No newline at end of file