diff options
| author | Lluis Sanchez <llsan@microsoft.com> | 2022-10-06 14:15:35 +0300 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-10-06 14:15:35 +0300 |
| commit | 9eaab025099bc82c0fc31379afa95786aa7fcdfa (patch) | |
| tree | 64743938fd08f43c019c25b4d3930e49d728bd4c | |
| parent | 6ecf8a277742c0a8e8a351987a67eee13a515be9 (diff) | |
| parent | 31758a630d794beb088a562cb55c77b937e0960b (diff) | |
Merge pull request #196 from mono/slluis-patch-2
Update and rename README to README.md
| -rw-r--r-- | README | 45 | ||||
| -rw-r--r-- | README.md | 23 |
2 files changed, 23 insertions, 45 deletions
@@ -1,45 +0,0 @@ - -Mono.Addins is a generic framework for creating extensible applications, -and for creating libraries which extend those applications. - -For for information about the library, see: -http://www.mono-project.com/Mono.Addins - -Building --------- - -To build the library execute: - - ./configure - make - -Options: - ---prefix=/path/to/prefix - - Install to the specified prefix - ---enable-gui - - Include GUI support for GTK2 (requires gtk#2) - ---enable-gui-gtk3 - - Include GUI support for GTK3 (requires gtk#3) - ---enable-tests - - Include NUnit tests (requires nunit) - - -Building the samples --------------------- - -cd to the Samples directory and run make. - -Running the NUnit tests ------------------------ - -To run the NUnit tests, you need to configure the build with --enable-tests, -cd to Tests, and run 'make test'. - diff --git a/README.md b/README.md new file mode 100644 index 0000000..835adb4 --- /dev/null +++ b/README.md @@ -0,0 +1,23 @@ +Mono.Addins is a framework for creating extensible applications, and for creating libraries which extend those applications. + +Mono.Addins has been designed to be easy to use and useful for a wide range of applications: from simple applications with small extensibility needs, to complex applications which need support for large add-in structures. + +The main features of Mono.Addins are: + +* Supports descriptions of add-ins using custom attributes (for simple and common extensions) or using an xml manifest (for more complex extensibility needs). +* Support for add-in hierarchies, where add-ins may depend on other add-ins. +* Lazy loading of add-ins. +* Provides an API for accessing to add-in descriptions, which will allow building development and documentation tools for handling add-ins. +* Dynamic activation / deactivation of add-ins at run time. +* Allows sharing add-in registries between applications, and defining arbitrary add-in locations. +* Allows implementing extensible libraries. +* Supports add-in localization. +* In addition to the basic add-in engine, it provides a Setup library to be used by applications which want to offer basic add-in management features to users, such as enabling/disabling add-ins, or installing add-ins from on-line repositories. + +## Building + +Open Mono.Addins.sln and build. + +## Documentation + +Extensive documentation is available in this project's [wiki](https://github.com/mono/mono-addins/wiki). |