Skip to content

Commit f1f3201

Browse files
committed
Corrected wierd comments on line breaks
1 parent 3b2dce1 commit f1f3201

File tree

1 file changed

+15
-1
lines changed

1 file changed

+15
-1
lines changed

README.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,20 @@ Then, for each target add either the DSL (for just the DSL) or both (for the Swi
4646
Check out the (super basic) [previews at the bottom of MapView.swift](Sources/MapLibreSwiftUI/MapView.swift)
4747
or more detailed [Examples](Sources/MapLibreSwiftUI/Examples) to see how it works in practice.
4848

49+
## Developer Quick Start
50+
51+
This project uses [`swiftformat`](https://github.com/nicklockwood/SwiftFormat) to automatically handle basic swift formatting
52+
as well as to lint and ensure conformance in PRs. Check out the swiftformat [Install Guide](https://github.com/nicklockwood/SwiftFormat?tab=readme-ov-file#how-do-i-install-it)
53+
to add swiftformat to your machine.
54+
55+
Once installed, you can autoformat code using the command:
56+
57+
```sh
58+
swiftformat .
59+
```
60+
61+
Swiftformat can occasionally poorly resolve a formatting issue (e.g. when you've already line-broken a large comment). Issues like this are typically easy to manually correct.
62+
4963
## Structure
5064

5165
This package is structured into a few targets. `InternalUtils` is pretty much what it says. `MapLibreSwiftDSL` and
@@ -85,4 +99,4 @@ things like fleshing out the expresison API helpers (which will be highly repeti
8599
check out the issue tracker, as these sholud be noted there.
86100

87101
TODO: Look at PointFree's Snapshot testing that generates images of SwiftUI views. Also look at inline snapshotting.
88-
https://github.com/pointfreeco/swift-snapshot-testing
102+
https://github.com/pointfreeco/swift-snapshot-testing

0 commit comments

Comments
 (0)