[hyena] Update README
- From: Gabriel Burt <gburt src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [hyena] Update README
- Date: Sat, 5 Jun 2010 19:42:44 +0000 (UTC)
commit 09fe6f4cf16d92d376fb27f9629298ad9fb90dec
Author: Gabriel Burt <gabriel burt gmail com>
Date: Sat Jun 5 12:42:36 2010 -0700
Update README
README | 51 +++++++++++++++++++++++++++++++++++++++------------
1 files changed, 39 insertions(+), 12 deletions(-)
---
diff --git a/README b/README
index 6b08eff..b79c07d 100644
--- a/README
+++ b/README
@@ -3,19 +3,46 @@ This is a library of useful GUI and non-GUI C# code, originally used in Banshee.
NOTE
** It is not API stable, and so is not installed to the GAC.**
-Applications using it should make a local copy of whatever components you use.
-That is, you should consider Hyena a build-time dependency, not a run-time, since
-at run-time your app will contain a copy of Hyena.
+There are three ways to use Hyena in your app:
-There are variables defined in the pkg-config files that contain assemblies
-and files needed for a given component of Hyena (eg hyena, hyena.data.sqlite,
-and hyena.gui).
+1) Require it as an external dep; copy its .dll files into your project
-pkg-config --variable=Assemblies hyena
-pkg-config --variable=Files hyena
+ Applications using it should make a local copy of whatever components you use.
+ That is, you should consider Hyena a build-time dependency, not a run-time, since
+ at run-time your app will contain a copy of Hyena.
-You can look at PDF Mod for an example of how to use Hyena:
+ There are variables defined in the pkg-config files that contain assemblies
+ and files needed for a given component of Hyena (eg hyena, hyena.data.sqlite,
+ and hyena.gui).
-http://git.gnome.org/cgit/pdfmod/tree/configure.ac
-http://git.gnome.org/cgit/pdfmod/tree/Makefile.am
-http://git.gnome.org/cgit/pdfmod/tree/src/Makefile.am
+ pkg-config --variable=Assemblies hyena
+ pkg-config --variable=Files hyena
+
+ You can look at PDF Mod for an example of how to use Hyena:
+
+ http://git.gnome.org/cgit/pdfmod/tree/configure.ac
+ http://git.gnome.org/cgit/pdfmod/tree/Makefile.am
+ http://git.gnome.org/cgit/pdfmod/tree/src/Makefile.am
+
+2) Include it as a submodule in your git repo
+
+ This is advantageous if you want to closely track and maybe contribute
+ back to Hyena. It also means developers don't have to install Hyena
+ themselves from packages or git.
+
+ git submodule add git://git.gnome.org/hyena
+ git submodule update --init
+ git add .gitmodules
+
+ Then you'll need to add Hyena to your build system. See Banshee's setup:
+
+ http://git.gnome.org/cgit/banshee/tree/configure.ac
+ http://git.gnome.org/cgit/banshee/tree/Makefile.am
+
+ You can also include the appropriate .csproj in your .sln. Set them to
+ build under the 'Submodule' configuration, and the binaries will get
+ outputted to ../bin from the Hyena checkout directory.
+
+3) Bundle the .dll files in your project
+
+ It's an expedient, but not good form for FOSS projects.
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]