From c3405486ee3c7ea91f78664dbede08dfde81bd5a Mon Sep 17 00:00:00 2001 From: Therzok Date: Tue, 29 Oct 2013 22:17:04 +0200 Subject: [README] Replace old readme with markdown. --- README.md | 123 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 123 insertions(+) create mode 100644 README.md (limited to 'README.md') diff --git a/README.md b/README.md new file mode 100644 index 0000000000..41a3763a3c --- /dev/null +++ b/README.md @@ -0,0 +1,123 @@ +**MonoDevelop** is a full-featured integrated development environment (IDE) for mono +using Gtk#. + +See http://www.monodevelop.com for more info. + +Directory organization +---------------------- + +There are two main directories: + + * main: The core MonoDevelop assemblies and add-ins (all in a single + tarball/package). + * extras: Additional add-ins (each add-in has its own + tarball/package). + +Compiling +--------- + +If you are building from Git, make sure that you initialize the submodules +that are part of MonoDevelop, to do this execute: + +`git submodule update --init --recursive` + +To compile execute: + +`./configure ; make` + +There are two variables you can set when running 'configure': + +`--prefix=/path/to/prefix: To set the install prefix.` + +You can use `--prefix="pkg-config --variable=prefix mono"` to get MD +installed with the rest of mono/gtk-sharp/etc. + +`--profile=profile-name: To choose one build profile.` + +There are some predefined profiles: + + * stable: builds the MonoDevelop core and some stable extra add-ins. + * core: builds the MonoDevelop core only. + * all: builds everything + +You can create your own profiles if you need to + +To create a profile you only have to add a file to the profiles directory +containing a list of the directories to build. + +You can run MonoDevelop from the build directory without having to +install it by executing: + +`make run` + +Installing *(Optional)* +---------- + +`make install` + +(It's possible that you need to install for your locale to be +correctly set.) + +Packaging for OSX +----------------- + +To package MonoDevelop for OSX in a convenient MonoDevelop.app +file, just do this after MonoDevelop has finished building (with +make): + +`cd main/build/MacOSX ; make MonoDevelop.app` + +Dependencies +------------ + + Mono >= 3.0.4 + Gtk# >= 2.12.8 + monodoc >= 1.0 + mono-addins >= 0.6 + +Special Environment Variables +----------------------------- + +BUILD_REVISION + + If this environment variable exists we assume we are compiling inside wrench. + We use this to enable raygun only for 'release' builds and not for normal + developer builds compiled on a dev machine with 'make && make run'. + + +References +---------- + +**MonoDevelop website** + +http://www.monodevelop.com + +**Gnome Human Interface Guidelines (HIG)** + +http://developer.gnome.org/projects/gup/hig/1.0/ + +**freedesktop.org standards** + +http://freedesktop.org/Standards/ + +**Integrating with GNOME (a little out of date)** + +http://developers.sun.com/solaris/articles/integrating_gnome.html + +**Bugzilla** + +http://bugzilla.mozilla.org/bugwritinghelp.html + +http://bugzilla.mozilla.org/page.cgi?id=etiquette.html + +Discussion, Bugs, Patches +------------------------- + +monodevelop-list@lists.ximian.com *(questions and discussion)* + +monodevelop-patches-list@lists.ximian.com *(track commits to MonoDevelop)* + +monodevelop-bugs@lists.ximian.com *(track MonoDevelop bugzilla component)* + +http://bugzilla.xamarin.com *(submit bugs and patches here)* + -- cgit v1.2.3