|
|
@@ -1,87 +1,57 @@
|
|
|
-openNAMU
|
|
|
+고픈 나무
|
|
|
====
|
|
|
-[](https://python.org)
|
|
|
-[](./LICENSE)
|
|
|
+[](https://python.org)
|
|
|
+[](./LICENSE)
|
|
|
|
|
|
|
|
|
|
|
|
-openNAMU is a Python-based wiki engine. You can use openNAMU by installing Python and its dependency modules, and you can modify the code yourself to create more specialized wikis.
|
|
|
+오픈나무는 파이썬 기반의 위키 엔진입니다. 파이썬과 그 의존성 모듈만 설치하면 사용할 수 있으며, 코드를 직접 수정하여 좀 더 주제에 특화된 위키를 만들 수 있습니다.
|
|
|
|
|
|
- * [(README for Korean)](./readme-ko.md)
|
|
|
+ * [(README for english)](./readme-en.md)
|
|
|
+### 목차
|
|
|
+ * [클론](#클론)
|
|
|
+ * [기여](#기여)
|
|
|
+ * [라이선스](#라이선스)
|
|
|
+ * [기여자 목록](#기여자-목록)
|
|
|
+ * [기타](#기타)
|
|
|
|
|
|
-### Index
|
|
|
- * [Getting Started](#getting-started)
|
|
|
- * [Clone](#clone)
|
|
|
- * [Contribute](#contribute)
|
|
|
- * [License](#license)
|
|
|
- * [Authors](#authors)
|
|
|
- * [Etc.](#etc)
|
|
|
+## 시작하기
|
|
|
+오픈나무는 파이썬 환경에서 동작하는 파이썬 애플리케이션으로, 파이썬 환경을 필요로 합니다.
|
|
|
|
|
|
-# Getting Started
|
|
|
-openNAMU is based upon Python, and it requires a Python environment.
|
|
|
+쉬운 오픈나무 설치를 위해 오픈나무 가이드를 따로 생성해두었으며, [이곳](https://github.com/2du/openNAMU/wiki/%EC%84%A4%EC%B9%98%EB%B2%95)에서 확인하실 수 있습니다.
|
|
|
|
|
|
-## Set-Ups
|
|
|
-### Install Python
|
|
|
-See [Python Installation Guide(KR)](https://github.com/404-sdok/how-to-python/blob/master/0.md).
|
|
|
-
|
|
|
-### Download Releases
|
|
|
-Download the [release version of openNAMU](https://github.com/2du/openNAMU/releases), and unzip the file. It is also possible to download releases by [cloning this repository](#Clone).
|
|
|
-
|
|
|
-### Install Modules
|
|
|
-Windows
|
|
|
-```
|
|
|
-pip install -r requirements.txt
|
|
|
-```
|
|
|
-
|
|
|
-Linux
|
|
|
-```
|
|
|
-pip3 install -r requirements.txt
|
|
|
-```
|
|
|
-## Launching Application
|
|
|
-Windows
|
|
|
-```
|
|
|
-python app.py
|
|
|
-```
|
|
|
-
|
|
|
-Linux
|
|
|
-```
|
|
|
-python3 app.py
|
|
|
-```
|
|
|
-
|
|
|
-## Publishing Application
|
|
|
-
|
|
|
-# 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`
|
|
|
|
|
|
-## Beta
|
|
|
+### 개발중
|
|
|
* `git clone -b master https://github.com/2du/openNAMU.git`
|
|
|
|
|
|
-# 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)
|
|
|
+## 기여
|
|
|
+오픈나무에는 검증되지 않은 몇가지 버그가 존재할 수 있습니다. 당신의 오픈나무 사용과 버그 발견은 오픈나무의 발전을 돕습니다.
|
|
|
+[이슈 생성하기](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)
|
|
|
+오픈나무는 완전한 오픈소스 프로젝트입니다. 새로운 기능을 추가하고 Pull Request를 생성해보세요.
|
|
|
+[Pull Request 생성하기](https://github.com/2du/openNAMU/compare)
|
|
|
|
|
|
-# Lisence
|
|
|
-openNAMU is protected by [BSD 3-Clause License](./LICNESE). Please refer to the documentation for details.
|
|
|
+## 라이선스
|
|
|
+오픈나무 프로젝트는 [BSD 3-Clause License](./LICENSE)(이하 이용허락)의 보호를 받고 있으며, 오픈나무 프로젝트를 사용하고자 한다면 라이선스를 준수해야 합니다. 본 이용허락를 위반할 경우 개발자는 DMCA Takedown 등 관련 제재를 관계자에게 요청할 권리가 있으며, 그 책임은 모두 이용허락 위반 사용자에게 있습니다. 자세한 내용은 문서를 참고하세요.
|
|
|
|
|
|
-## External Projects
|
|
|
- * Quotes icon [Dave Gandy](http://www.flaticon.com/free-icon/quote-left_25672)
|
|
|
- * Syntax highlighting [highlightjs](https://highlightjs.org/)
|
|
|
- * Numerical expression [MathJax](https://www.mathjax.org/)
|
|
|
+### 포함된 외부 프로젝트
|
|
|
+ * Quotes icon - [Dave Gandy](http://www.flaticon.com/free-icon/quote-left_25672)
|
|
|
+ * Syntax highlighting - [highlightjs](https://highlightjs.org/)
|
|
|
+ * Numerical expression - [MathJax](https://www.mathjax.org/)
|
|
|
* Handling Keyboard Shortcuts [shortcut.js](http://www.openjs.com/scripts/events/keyboard_shortcuts/)
|
|
|
|
|
|
-# Authors
|
|
|
- * [Reference](https://github.com/2DU/openNAMU/graphs/contributors)
|
|
|
+## 기여자 목록
|
|
|
+ * [참고](https://github.com/2DU/openNAMU/graphs/contributors)
|
|
|
|
|
|
-## Special Thanks
|
|
|
+### 도움을 주신 분들
|
|
|
* [Team Croatia](https://github.com/TeamCroatia)
|
|
|
* Basix
|
|
|
* Efrit
|
|
|
- * Other chat rooms
|
|
|
+ * 기타 채팅방 사람들
|
|
|
|
|
|
-# Etc.
|
|
|
- * Owner rights are granted to the first registor.
|
|
|
+## 기타
|
|
|
+ * 첫 가입자에게 소유자 권한이 부여됩니다.
|
Surplus_Up (2DU)