From 2b077865519a696d69f9c7b95f29f1b9626b2ecd Mon Sep 17 00:00:00 2001
From: ened <acedealer2014@gmail.com>
Date: Tue, 30 May 2023 20:00:33 +0900
Subject: [PATCH] How to build documentation

---
 README.md         | 71 +++++++++++++++++++++++++++++++++++++++++++++--
 scripts/build.ps1 |  2 +-
 2 files changed, 70 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index ffd8959..763836a 100644
--- a/README.md
+++ b/README.md
@@ -63,9 +63,9 @@ KissMeGolder 는 KissMeMatrix model 을 충실하게 따르면서, 자동으로
 사용하고자 하는 model 에 따라서 다양한 투자 성향을 가질 수 있도록 설계할 것입니다.
 
 
-# credential
+# Credential json
 
-credential 에서 사용하는 json 의 양식은 다음과 같습니다.
+credential 로 사용하는 json 의 양식은 다음과 같습니다.
 
 ### mock-server.json, real-server.json
 
@@ -78,6 +78,8 @@ credential 에서 사용하는 json 의 양식은 다음과 같습니다.
 }
 ```
 
+mock-server.json, real-server.json 파일을 `./bin` 디렉토리에 생성합니다.
+
 * `isMock` 값이 `true` 이면 모의서버, `false` 이면 실전서버를 의미합니다.
 * `accountNo` 에는 계좌번호를 의미합니다. 8-2 형태의 숫자로 입력합니다.
 * `appKey` 는 [한국투자증권](https://apiportal.koreainvestment.com) 홈페이지에서 발급받은 appkey 입니다.
@@ -90,7 +92,72 @@ credential 에서 사용하는 json 의 양식은 다음과 같습니다.
   "openApiKey": "zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz"
 }
 ```
+shop-server.json 파일을 `./bin` 디렉토리에 생성합니다.
 
 * `openApiKey` 는 [data.go.kr](https://www.data.go.kr/) 에서 발급받은 API 인증키입니다.
 * 다음의 Open API 활용신청을 합니다.
   * [금융위원회_KRX상장종목정보](https://www.data.go.kr/tcs/dss/selectApiDataDetailView.do?publicDataPk=15094775)
+
+
+# How to build
+
+## macOS
+
+macOS 환경에서는 최신 Xcode 14.x 이상을 설치하고, Command line tool 을 설치하면 됩니다.
+
+```bash
+% xcode-select --install
+```
+
+다음의 script 로 빌드하고, `./bin` 경로에서 빌드된 tool 들을 이용하면 됩니다.
+
+```bash
+% git clone git@github.com:whomakemecrazy/kissme.git
+%
+% cd kissme
+% ./script/build.sh
+%
+% cd bin
+% ./KissMeConsole
+```
+
+## Linux
+
+Linux 는 현재 ubuntu 20.4 를 지원합니다.
+다음의 guide 를 따라서, swift 컴파일러를 설치합니다.
+* [Installing Swift on Ubuntu 20.04](https://gist.github.com/Jswizzy/408af5829970f9eb18f9b45f891910bb)
+
+```bash
+$ cd kissme
+$ ./script/build.sh
+$
+$ cd bin
+$ ./KissMeConsole
+```
+
+
+## Windows
+
+Windows 는 현재 Windows 10 이상을 지원합니다.
+다음의 사이트에서 Swift 컴파일러를 설치합니다.
+* [Download Swift](https://www.swift.org/download/)
+
+다음의 script 로 빌드하고, `.\bin` 경로에서 빌드된 tool 들을 이용하면 됩니다.
+
+```shell
+PS >> cd kissme
+PS >> powershell ./scripts/build.ps1
+PS >>
+PS >> cd .\bin
+PS >> .\KissMeConsole
+```
+
+
+## Android (TODO)
+
+Android 는 cross compile 과정이 필요하기 때문에 차후에 지원할 예정입니다.
+
+
+# License
+
+이 소스의 라이센스는 Private 입니다.
diff --git a/scripts/build.ps1 b/scripts/build.ps1
index 42f81e0..096e7d5 100644
--- a/scripts/build.ps1
+++ b/scripts/build.ps1
@@ -1,6 +1,6 @@
 ## Run this build script at root
 ## Ex)
-##    > powershell ./scripts/build.sh
+##    > powershell ./scripts/build.ps1
 ##
 
 $CONSOLE_APP = "KissMeConsole"