diff --git a/Dependencies.md b/Dependencies.md new file mode 100644 index 0000000..99a44fb --- /dev/null +++ b/Dependencies.md @@ -0,0 +1,33 @@ +Nuclex.Support Dependencies +=================================== + + +To Compile the Library +---------------------- + +This project is intended to be placed into a source tree using submodules to replicate +the following directory layout: + + root/ + Nuclex.Windows.Forms/ <-- you are here + Nuclex.Windows.Forms (net-4.6).csproj + + Nuclex.Support.Native/ <-- Git: nuclex-shared-dotnet/Nuclex.Support + Nuclex.Support (net-4.6).csproj + + third-party/ + nunit + nmock + +You should already have that directory layout in playe if you cloned the "frame fixer" +repository (with `--recurse-submodules`). + + * Nuclex.Support + * nunit (optional, if unit tests are built) + * nmock (optional, if unit tests are built) + + +To Use this Library as a Binary +------------------------------- + + * Nuclex.Support.dll diff --git a/License.md b/License.md new file mode 100644 index 0000000..15020da --- /dev/null +++ b/License.md @@ -0,0 +1,180 @@ +Apache License +============== + +Version 2.0, January 2004 +http://www.apache.org/licenses/ + + +TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION +------------------------------------------------------------ + + 1. _Definitions_. + + **"License"** shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + **"Licensor"** shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + **"Legal Entity"** shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + **"control"** means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + **"You"** (or **"Your"**) shall mean an individual or Legal Entity + exercising permissions granted by this License. + + **"Source"** form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + **"Object"** form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + **"Work"** shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + **"Derivative Works"** shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + **"Contribution"** shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, **"submitted"** + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as **"Not a Contribution."** + + **"Contributor"** shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. _Grant of Copyright License_. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. _Grant of Patent License_. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. _Redistribution_. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + - **(a)** You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + - **(b)** You must cause any modified files to carry prominent notices + stating that You changed the files; and + + - **(c)** You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + - **(d)** If the Work includes a **"Notice.md"** text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such **Notice.md** file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. _Submission of Contributions_. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. _Trademarks_. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. _Disclaimer of Warranty_. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. _Limitation of Liability_. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. _Accepting Warranty or Additional Liability_. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS diff --git a/Notice.md b/Notice.md new file mode 100644 index 0000000..d51f0cd --- /dev/null +++ b/Notice.md @@ -0,0 +1,48 @@ +Nuclex.Windows.Forms Attribution +================================ + +This library is licensed under the Apache License 2.0, +http://www.apache.org/licenses/ + + +You can: +-------- + +- Use this library in closed source and commercial applications. +- Distribute this library's unmodified source code. +- Distribute binaries compiled from the unmodified source code. + +- Modify the source code of this library and keep the changes to yourself. +- Modify the source code of this library and publish the changes, + so long as you make it very clear that, and how, you changed the code. + + +You can not: +------------ + +- Put this library under a different license or +- Sell access to this library's code + +- Sue anyone for issues you have with this code. + +- Pretend that you wrote this +- Use the names of any of this library's authors to promote your own work. + + +Attribution +=========== + +If you distribute binaries of this library, you should include this license +file somewhere in your documentation or other legal text. + +A mention of your product's use of this library as well as of the embedded +third-party libraries in your splash screen, credits or such would be nice, +but is not required. + + +Example Attribution Text +------------------------ + +Uses supporting code from the Nuclex.Windows.Forms library, written by +Markus Ewald and licensed under the terms of the Apache License 2.0 +(http://www.apache.org/licenses/) diff --git a/ReadMe.md b/ReadMe.md new file mode 100644 index 0000000..dc6edfe --- /dev/null +++ b/ReadMe.md @@ -0,0 +1,17 @@ + - **Status:** Stable and mature. Several projects are using this library, + and it has received extensive testing on Linux and Windows. + + - **Platforms:** Cross-platform, developed on Linux but also tested and + working without any known issues on Windows. + +Nuclex.Windows.Forms +==================== + +This is a lightweight MVVM framework for Windows Forms. It is based on +the "convention over configuration" idea and requires zero configuration. +Rather than set up view mappings and view model services, you can simply +ask it to display a view model (`ExampleViewModel`) with its default view +and it will figure out what the correct view is by name (i.e. `ExampleForm`). + +There are unit tests for the whole library, so everything is verifiably +working on all platforms tested (Linux, Windows, Raspberry).