Skip to content

Commit

Permalink
updating license and nuspec
Browse files Browse the repository at this point in the history
  • Loading branch information
stevenbrix committed Oct 27, 2023
1 parent 108f24a commit 16d46fc
Show file tree
Hide file tree
Showing 6 changed files with 66 additions and 30 deletions.
22 changes: 0 additions & 22 deletions LICENSE

This file was deleted.

29 changes: 29 additions & 0 deletions LICENSE.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
BSD 3-Clause License

Copyright (c) 2023, The Browser Company
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.

3. Neither the name of the copyright holder nor the names of its
contributors may be used to endorse or promote products derived from
this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32 changes: 32 additions & 0 deletions nuget/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# Swift/WinRT

The TheBrowserCompany.SwiftWinRT NuGet package automatically generates swift code, enabling you consume Windows Runtime classes.

The Swift/WinRT package is a tool only package. The tool requires the user to gather the appropriate inputs.

## Usage

Below is a table of the appropriate parameters to pass to swiftwinrt.exe

| Name | Description |
|--------------|-------------------------------------------------|
| `-input` | Input winmd file for generating bindings from |
| `-include` | Types/Namespaces to generate bindings for. |
| `-exclude` | Types/Namespaces to exclude |
| `-reference` | WinMD file for reference or Windows SDK version |
| `-output` | Output location to place generated bindings |
| `@<path.rsp>`| path to .rsp file with all parameters |

Swift/WinRT is flexible on the bindings that it will generate. No matter the combination of parameters you provide, it will ensure you have code that will compile. Note that specific excludes will always override an include. It is recommended to use a response file to pass parameters to Swift/WinRT. Here is an example of what a response file may look like:

```
-include MyComponent
-include Windows.Foundation.Collections
-input C:/dev/MyComponent/build/MyComponent.winmd
-output C:/dev/MyComponent/Sources/MyComponent
-reference 10.0.17763.0
```

You could then invoke Swift/WinRT like:

> swiftwinrt.exe @c:/dev/MyComponent/MyComponent.rsp
6 changes: 0 additions & 6 deletions nuget/readme.txt

This file was deleted.

5 changes: 4 additions & 1 deletion nuget/swiftwinrt.nuspec
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,12 @@
<copyright>© The Browser Company of New York. All rights reserved.</copyright>
<projectUrl>https://github.com/thebrowsercompany/swiftwinrt</projectUrl>
<repository type="git" url="https://github.com/thebrowsercompany/swiftwinrt"/>
<license type="expression">BSD-3-Clause</license>
<readme>readme.md</readme>
</metadata>
<files>
<file src="$swiftwinrt_exe$" target="bin"/>
<file src="readme.txt"/>
<file src="readme.md"/>
<file src="../LICENSE.txt" target=""/>
</files>
</package>
2 changes: 1 addition & 1 deletion swiftwinrt/main.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ Where <spec> is one or more of:
settings.test = args.exists("test");
settings.output_folder = args.value("output", ".");

settings.support = args.value("support", "Windows");
settings.support = args.value("support", "WindowsFoundation");

create_directories(settings.output_folder);
create_directories(writer::root_directory());
Expand Down

0 comments on commit 16d46fc

Please sign in to comment.