|
|
@@ -1,22 +1,57 @@
|
|
|
opennamu
|
|
|
====
|
|
|
-opennamu는 파이썬 기반의 위키엔진입니다. (파이썬 3.5 이상)
|
|
|
+
|
|
|
+opennamu는 파이썬 기반의 위키 엔진입니다. 파이썬과 그 의존성 모듈만 설치하면 사용할 수 있으며, 코드를 직접 수정하여 좀 더 주제에 특화된 위키를 만들 수 있습니다.
|
|
|
|
|
|
-## 클론 명령어
|
|
|
-### 일반
|
|
|
+### 목차
|
|
|
+ * 시작하기
|
|
|
+ * 클론
|
|
|
+ * 기여
|
|
|
+ * 라이선스
|
|
|
+ * 기여자 목록
|
|
|
+ * 기타
|
|
|
+
|
|
|
+# 시작하기
|
|
|
+ * 오픈나무 위키에 명시되어 있습니다. [참조](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 설명
|
|
|
+# 기여
|
|
|
+opennamu에는 검증되지 않은 몇가지 버그가 존재할 수 있습니다. 당신의 opennamu사용과 버그 발견은 opennamu의 발전을 돕습니다.
|
|
|
+[이슈 생성하기](https://github.com/2du/opennamu/issues/new)
|
|
|
+
|
|
|
+opennamu는 완전한 오픈소스 소프트웨어입니다. 새로운 기능을 추가하고 Pull Request를 해보세요. [다음 절차]에 따라 기여할 수 있습니다.
|
|
|
+[Pull Request 생성하기](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/)
|
|
|
- * 첫 번째 가입자에게 소유자 권한이 부여됩니다.
|
|
|
+첫 번째 가입자에게 소유자 권한이 부여됩니다.
|