Fixed a bug and added README
commitc31f002c270b38dccc66d71d866a55a338cd01f0
authorilyakooo0 <ilyakooo0@gmail.com>
dateFri 24 Aug 2018, 18:07 (8 years ago)
parent17dbfa5
README.md+26
@@ -1,3 +1,29 @@
11# SourceDocsSwift
22
33Генернирует LaTeX-таблицы всех классов, структур и их полей и методов из проекта Xcode для вставки в техническую документацию.
4+
5+## Установка
6+
7+```bash
8+brew install ilyakooo0/tap/sourceDocsSwift
9+```
10+
11+## Использование
12+
13+```bash
14+sourceDocsSwift -i path/to/XcodePrjectDirectory/ -o path/to/output/docs.tex
15+```
16+
17+По умолчанию ищет проект в текущей папке и пишет результат в эту же папку в файл `docas.tex`.
18+
19+В LaTeX документ можно вставить просто положив рядом с щсновным `.tex` документом и вставив в нужное место:
20+
21+```LaTeX
22+\include{doc}
23+```
24+
25+Так же требуется пакет `longtable`. Если в вашем шаблоне этого еще нигде нет, то где-нибудь в преамбуле надо вставить:
26+
27+```LaTeX
28+\usepackage{longtable}
29+```
SourceDocsSwift/main.swift−5
@@ -8,14 +8,9 @@
88
99import Foundation
1010
11−//let directory = "/Users/ilya/Developer/Dotrix/Dotrix/"
12−//let output = "/Users/ilya/Desktop/foo.tex"
13−
1411let args = Array(CommandLine.arguments.dropFirst())
1512let temp = FileManager.default.temporaryDirectory.appendingPathComponent("SourceDocsSwift/build\(Date().timeIntervalSince1970)")
1613
17−print(temp)
18−
1914var output = "docs.tex"
2015var directory: String?
2116