Merge pull request #568 from kpjhg0124/master

리드미 구성 수정 및 몇가지 변경 사항

license.md → LICENSE

@@ -1,6 +1,6 @@
-## BSD 3-Clause License
+BSD 3-Clause License
 
-Copyright (c) 2017, 2DU
+Copyright (c) 2017-2018, 2DU
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without
@@ -27,17 +27,3 @@ SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
-## External File License
- * Quotes icon [Dave Gandy](http://www.flaticon.com/free-icon/quote-left_25672) CC 3.0 BY
- * Syntax highlighting [highlightjs](https://highlightjs.org/)
- * Numerical expression [MathJax](https://www.mathjax.org/)
-
-## Contributors
- * [Reference](https://github.com/2DU/openNAMU/graphs/contributors)
-
-## Helpful people
- * [Team Croatia](https://github.com/TeamCroatia)
- * Basix
- * Efrit
- * Other chat rooms

readme-ko.md

@@ -1,21 +1,58 @@
-## 개요
-파이썬 위키 엔진 입니다. (파이썬 3.5 이상)
+opennamu
+====
+![Python 3.5 Required](https://img.shields.io/badge/python-3.5-blue.svg?longCache=true&style=flat-square)
 
-## 클론 명령어
-### 일반
+오픈나무는 파이썬 기반의 위키 엔진입니다. 파이썬과 그 의존성 모듈만 설치하면 사용할 수 있으며, 코드를 직접 수정하여 좀 더 주제에 특화된 위키를 만들 수 있습니다.
+
+### 목차
+ * [시작하기](#시작하기)
+ * [클론](#클론)
+ * [기여](#기여)
+ * [라이선스](#라이선스)
+ * [기여자 목록](#기여자-목록)
+ * [기타](#기타)
+
+# 시작하기
+ * 오픈나무 위키에 명시되어 있습니다. [참조](http://namu.ml/w/오픈나무%2F설치법)
+
+# 클론
+아래 명령을 터미널(명령 프롬프트)에 입력하여 본 리포지토리를 클론할 수 있습니다.
+## 일반
  * `git clone -b stable https://github.com/2du/opennamu.git`
 
-### 베타
+## 베타
  * `git clone -b master https://github.com/2du/opennamu.git`
 
-## 설치법
- * [참조](http://namu.ml/w/오픈나무%2F설치법)
- 
-## set.json 설명
+# 기여
+오픈나무에는 검증되지 않은 몇가지 버그가 존재할 수 있습니다. 당신의 오픈나무 사용과 버그 발견은 오픈나무의 발전을 돕습니다.
+[이슈 생성하기](https://github.com/2du/opennamu/issues/new)
+
+오픈나무는 완전한 오픈소스 프로젝트입니다. 새로운 기능을 추가하고 Pull Request를 해보세요. [다음 절차]에 따라 기여할 수 있습니다.
+[Pull Requests 생성하기](https://github.com/2du/opennamu/compare)
+
+# 라이선스
+오픈나무는 [BSD 3-Clause License](./LICENSE)에 의해 보호받고 있습니다. 자세한 내용은 문서를 참고하세요.
+
+## 외부 프로젝트 라이선스
+ * Quotes icon [Dave Gandy](http://www.flaticon.com/free-icon/quote-left_25672) CC 3.0 BY
+ * Syntax highlighting [highlightjs](https://highlightjs.org/)
+ * Numerical expression [MathJax](https://www.mathjax.org/)
+
+# 기여자 목록
+ * [참고](https://github.com/2DU/opennamu/graphs/contributors)
+
+## 도움을 주신 분들
+ * [Team Croatia](https://github.com/TeamCroatia)
+ * Basix
+ * Efrit
+ * Other chat rooms
+
+# 기타
+`set.json`은 몇가지 로컬 설정을 저장하는 설정 파일입니다.
  * db = 데이터베이스 이름
 
-set.json를 삭제하면 다시 새로 만들 수 있습니다.
+`set.json`은 삭제해도 다시 새로 만들 수 있습니다.
+
+[테스트 서버](http://namu.ml/)
 
-## 기타
- * [테스트 서버](http://namu.ml/)
- * 첫 번째 가입자에게 소유자 권한이 부여됩니다.
+첫 번째 가입자에게 소유자 권한이 부여됩니다.

readme.md

@@ -1,24 +1,59 @@
-## intro
-wiki engine made python. (python 3.5 or later)
+opennamu
+====
+![Python 3.5 Required](https://img.shields.io/badge/python-3.5-blue.svg?longCache=true&style=flat-square)
 
-## clone command
-### stable
+opennamu is a Python-based wiki engine. If you install Python and its underlying modules, you will be able to create wikis.
+
+ * [(README for korean)](./readme-ko.md)
+
+### Index
+ * [Getting Started](#getting-started)
+ * [Clone](#clone)
+ * [Contribute](#contribute)
+ * [License](#license)
+ * [Authors](#authors)
+ * [Etc.](#etc.)
+
+# Getting Started
+
+# Clone
+You can clone this repository by entering the following command at the terminal (command prompt):
+## Stable
  * `git clone -b stable https://github.com/2du/opennamu.git`
 
-### master
+## Beta
  * `git clone -b master https://github.com/2du/opennamu.git`
 
-## install
- * [reference](https://namu.ml/w/opennamu%2Finstall)
- 
-## set.json explanation
- * db = Database Name
+# Contribute
+opennamu may have some untested bugs. Your use of opennamu and bug discovery will help develop opennamu.
+[Create Issues](https://github.com/2du/opennamu/issues/new)
+
+opennamu is open source project. Add new features and request pull requests. 
+[Create Pull Requests](https://github.com/2du/opennamu/compare)
+
+# Lisence
+opennamu is protected by [BSD 3-Clause License](./LICNESE). Please refer to the documentation for details.
+
+## External Projects
+ * Quotes icon [Dave Gandy](http://www.flaticon.com/free-icon/quote-left_25672) CC 3.0 BY
+ * Syntax highlighting [highlightjs](https://highlightjs.org/)
+ * Numerical expression [MathJax](https://www.mathjax.org/)
+
+# Authors
+ * [Reference](https://github.com/2DU/opennamu/graphs/contributors)
+
+## Special Thanks
+ * [Team Croatia](https://github.com/TeamCroatia)
+ * Basix
+ * Efrit
+ * Other chat rooms
+
+# Etc.
+`set.json` is a configuration file that stores some local settings.
+ * db = Database name
 
-you can create a new set.json by deleting it.
+If you delete `set.json`, you can create a new one again.
 
-## other
- * [test Server](http://namu.ml)
- * the first registor is granted owner privileges.
+[Test Server](http://namu.ml/)
 
-## 한국어
- * [참조](https://github.com/2du/opennamu/blob/master/readme-ko.md)
+Owner rights are granted to the first registor.