Skip to content
This repository was archived by the owner on Dec 12, 2024. It is now read-only.

Commit 9c94717

Browse files
authored
Fix markdown according to markdownlint. (#454)
1 parent da0654e commit 9c94717

File tree

4 files changed

+17
-14
lines changed

4 files changed

+17
-14
lines changed

BUILDING.md

+9-10
Original file line numberDiff line numberDiff line change
@@ -8,16 +8,15 @@ There are two options to installing Xcode:
88

99
1. Use automatic provisioning. This is done by executing `make provision` in `maccore/tools/tom-swifty`, but it may take a while to download Xcode unless you're in the Boston office, in which case it might be better to download Xcode manually (next option).
1010

11-
2. Download Xcode manually from https://download.developer.apple.com/Developer_Tools/Xcode_9.2/Xcode_9.2.xip
11+
2. Download Xcode manually from [https://download.developer.apple.com/Developer_Tools/Xcode_9.2/Xcode_9.2.xip](https://download.developer.apple.com/Developer_Tools/Xcode_9.2/Xcode_9.2.xip)
1212

13-
1. Extract and copy Xcode_9.2.xip to `/Applications/Xcode_9.2.app` (if you already have Xcode 9.2 in `/Applications/Xcode92.app`, you can just create a symlink: `ln -s /Applications/Xcode92.app /Applications/Xcode_9.2.app`)
14-
2. `sudo xcode-select -s /Applications/Xcode_9.2.app/`
13+
1. Extract and copy Xcode_9.2.xip to `/Applications/Xcode_9.2.app` (if you already have Xcode 9.2 in `/Applications/Xcode92.app`, you can just create a symlink: `ln -s /Applications/Xcode92.app /Applications/Xcode_9.2.app`)
14+
2. `sudo xcode-select -s /Applications/Xcode_9.2.app/`
1515

1616
### Notes
1717

1818
* there are other requirements (e.g. `cmake`, `ninja`) that I already have, most of them are likely needed to build `xamarin-macios`. It’s possible that I have some for others reasons too. Please update this document if you find any missing requirements.
1919

20-
2120
## Building
2221

2322
Create a directory to dedicate to Binding Tools for Swift, e.g.
@@ -38,7 +37,7 @@ Build everything. This will build the swift dependency (only if needed [1]) and
3837
toolchain is available in Azure, and if so, download and use that version.
3938
This behavior can be overriden by doing `export FORCE_SWIFT_BUILD=1`.
4039

41-
### Notes
40+
### Notes About Building
4241

4342
The above steps are doing a **full debug** build for swift. [build-script](https://github.com/xamarin/swift/blob/swift-4.0-branch-tomswifty/utils/build-script) can also produce different builds, e.g.
4443

@@ -53,15 +52,15 @@ Running `build-script` takes a **very long** time, so building extraneous local
5352
1. `cd maccore/tools/tom-swifty/tests/tom-swifty-test/`
5453
2. `make`
5554

56-
### Notes
55+
### Notes About Testing
5756

5857
* The new (incompatible but much more powerful) NUnit 3 runner means using the usual `FIXTURES` variable has to use a [different syntax](https://github.com/nunit/docs/wiki/Test-Selection-Language). E.g. to run a single test case from the command line you would do
5958

60-
```
59+
```shell
6160
FIXTURES="--where=test=SwiftReflector.LinkageTests.TestMissingNSObject" make
6261
```
6362

64-
6563
## Generated Source Files
66-
- `SwiftReflector/IOUtils/SwiftModuleList.g.cs` is generated via the `update_module_list.csharp` script.
67-
- `./update_module_list.csharp SwiftToolchain-v2-8efccc1464890d6c906fb2c40f909b5324da950d`
64+
65+
* `SwiftReflector/IOUtils/SwiftModuleList.g.cs` is generated via the `update_module_list.csharp` script.
66+
* `./update_module_list.csharp SwiftToolchain-v2-8efccc1464890d6c906fb2c40f909b5324da950d`

CONTRIBUTING.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
This project welcomes contributions and suggestions. Most contributions require you to
44
agree to a Contributor License Agreement (CLA) declaring that you have the right to,
55
and actually do, grant us the rights to use your contribution. For details, visit
6-
https://cla.microsoft.com.
6+
[https://cla.microsoft.com](https://cla.microsoft.com).
77

88
When you submit a pull request, a CLA-bot will automatically determine whether you need
99
to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the

QUICKSTART.md

+4-3
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ When you make binding-tools-for-swift, the build will bring down a copy of the b
6262
/path/to/binding-tools-for-swift/SwiftToolchain-v3/GITHASH/build/Ninja-ReleaseAssert/swift-macosx-x86_64/bin
6363
/path/to/binding-tools-for-swift/SwiftToolchain-v3/GITHASH/build/Ninja-ReleaseAssert/swift-macosx-x86_64/lib
6464

65-
Since the binding tools need to compile Swift wrappers that use some runtime glue, it needs a reference
65+
Since the binding tools need to compile Swift wrappers that use some runtime glue, it needs a reference
6666

6767
A typical set of commands to generate bindings is:
6868

@@ -82,11 +82,12 @@ The binding tools need the following to operate:
8282
In addition, the tools can operator on separate `.swiftmodule` and `.dylib` files. This can be handled by using a `-M` argument for the `.swiftmodule` and `-L` for the library. It’s easier to use the `.framework` directory and a single `-C` argument.
8383

8484
## Building and Running Samples
85+
8586
Samples source code is in the `samples` directory, but will not build and run there.
8687
Instead you need to make a packaged build, from the root of binding-tools-for-swift execute the command:
8788

88-
`make package`
89-
89+
make package
90+
9091
this will leave a directory inside of the directory `Pack-Man` named `binding-tools-for-swift` which contains buildable samples.
9192
Most samples can be built by executing `make` in their directory. To try out a sample, do `make runit` for most of the samples.
9293

README.md

+3
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ In order to contribute to Binding-Tools-For-Swift, you will need Xcode 10.2 !
1919
## Current Status
2020

2121
### What Binds?
22+
2223
- Classes
2324
- Structs
2425
- Enums
@@ -32,11 +33,13 @@ In order to contribute to Binding-Tools-For-Swift, you will need Xcode 10.2 !
3233
- Extensions
3334

3435
### What Doesn’t Bind Yet?
36+
3537
- Protocols with associated types
3638
- Bound generic types with closures
3739
- Non-escaping closures
3840

3941
### What Else Can I Expect?
42+
4043
- An `open` class in Swift can be subclassed in C# and the subclass can be passed in to Swift. Overridden virtual methods in C# will be called when invoked from Swift.
4144
- A C# type implementing an interface bound to a Swift protocol can be passed in to Swift. Methods and properties in the C# interface implementation will be called when invoked from Swift.
4245
- At runtime, the generated code honors the Swift Automatic Reference Counting as well as .NET garbage collection.

0 commit comments

Comments
 (0)