Skip to content

Commit 4bada71

Browse files
Olivier Halligondjbe
authored andcommitted
Added references to new wiki page in README
1 parent 07583c7 commit 4bada71

File tree

1 file changed

+10
-7
lines changed

1 file changed

+10
-7
lines changed

README.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -16,15 +16,15 @@ SwiftGen is a tool to auto-generate Swift code for resources of your projects, t
1616
<li><a href="#choosing-your-template">Choosing your template</a>
1717
<li><a href="#additional-documentation">Additional documentation</a>
1818
</ul>
19-
Then generate code (enums, constants, etc) for:
19+
Then generate constants for:
2020
<ul>
2121
<li><a href="#asset-catalog">Assets Catalogs</a>
2222
<li><a href="#colors">Colors</a>
2323
<li><a href="#fonts">Fonts</a>
2424
<li><a href="#interface-builder">Interface Builder files</a>
2525
<li><a href="#json-and-YAML">JSON and YAML files</a>
2626
<li><a href="#plist">Plists</a>
27-
<li><a href="#strings"><tt>Localizable.strings</tt></a>
27+
<li><a href="#strings">Localizable strings</a>
2828
</ul>
2929
</td>
3030
</tr></table>
@@ -259,16 +259,19 @@ The `SwiftGen.playground` available in this repository will allow you to play wi
259259

260260
This allows you to have a quick look at how typical code generated by SwiftGen looks like, and how you will then use the generated constants in your code.
261261

262-
### Markdown files
262+
### Dedicated Documentation in Markdown
263263

264-
There are also a lot of documentation in the form of Markdown files in this repository and the related [StencilSwiftKit](https://github.com/SwiftGen/StencilSwiftKit) repo as well. Be sure to check the "Documentation" folder of each repository.
264+
There are also a lot of documentation in the form of Markdown files in this repository and the related [StencilSwiftKit](https://github.com/SwiftGen/StencilSwiftKit) repo as well.
265+
266+
Be sure to [check the "Documentation" folder](Documentation/) of each repository.
265267

266268
### Wiki
267269

268-
You can also see in the [wiki](https://github.com/SwiftGen/SwiftGen/wiki) some additional documentation, about:
270+
You can also see in the [wiki](https://github.com/SwiftGen/SwiftGen/wiki) some additional documentation on specific topics, like:
269271

270-
* how to [integrate SwiftGen in your Continuous Integration](https://github.com/SwiftGen/SwiftGen/wiki/Continuous-Integration) (Travis-CI, CircleCI, Jenkins, …)
271-
* how to [integrate in your Xcode project](https://github.com/SwiftGen/SwiftGen/wiki/Integrate-SwiftGen-in-an-xcodeproj) so it rebuild the constants every time you build
272+
* [Integrate SwiftGen in your Continuous Integration](https://github.com/SwiftGen/SwiftGen/wiki/Continuous-Integration) (Travis-CI, CircleCI, Jenkins, …)
273+
* [Integrate SwiftGen in your Xcode project](https://github.com/SwiftGen/SwiftGen/wiki/Integrate-SwiftGen-in-an-xcodeproj) so it rebuild the constants every time you build
274+
* [Configure SwiftLint to help your developers use constants generated by SwiftGen](https://github.com/SwiftGen/SwiftGen/wiki/swiftlint-rules-for-SwiftGen)
272275
* …and more.
273276

274277
### Tutorials

0 commit comments

Comments
 (0)