yona-projects / yona star
doortts doortts 2014-06-30
readme: make readme better 
  - add detailed descriptions
  - add descriptions for those who don't have git client tools
  - remove unnessary words & sentences
  - add upgrade, backup guide
@3a109ec78f1ac5264070eaef58a098078680447d
3639fe3
3a109ec
README.md
--- README.md
+++ README.md
@@ -4,29 +4,33 @@
 
 =======
 
 [![Build Status](https://travis-ci.org/naver/yobi.png?branch=master)](https://travis-ci.org/naver/yobi)
 
 
-
 
-Yobi, collaborative SW development platform.<br/>
 
+Yobi is a web-based project hosting software.
 
 
 
 What is Yobi?
 
 --
 
 
-Yobi, a brand new version of nFORGE, is a web-based collaborative platform for software development.
 
-Yobi offers many features to increase productivity and quality of your software: a issue tracker to manage bugs and issue, a wiki style board to share documents, a configuration management tool to control software version and so on.
 
+Yobi is a web-based project hosting software.
 
+To increase productivity and quality of your software Yobi offers many features including
 
+
 
+- Issue tracker to manage bugs and issues
 
+- Bulletin board to share documents
 
+- Git/SVN support embedded
 
+- Pull-request for collaborative coding
 
 
 License
 
 --
 
-Copyright 2014 NAVER Corp, under the Apache 2.0 license.
 
+Copyright 2014 NAVER Corp. under the Apache License, Version 2.0
 
 
-## Installation
 
+## How to install
 
 
-### check java version
 
+### Check java version
 
 
     java -version
 
 
-Required minimum java version is 7(1.7)
 
+Java version 7(1.7) or above is required.
 
 
-### download playframework
 
+### Download playframework
 
 
     curl -O http://downloads.typesafe.com/play/2.1.0/play-2.1.0.zip
@@ -38,30 +42,36 @@
 
 
     http://downloads.typesafe.com/play/2.1.0/play-2.1.0.zip
 
 
-### unzip
 
+### Unzip
 
 
     unzip play-2.1.0.zip
 
 
-### cd to unzipped directory
 
+### Change directory to unzipped directory
 
 
     cd play-2.1.0
 
 
-### download yobi
 
+### Download Yobi
 
 
-    git clone https://github.com/naver/yobi.git -b maint yobi
 
+Case1. using [git client](http://git-scm.com/) (recommended)
 
+    
+    git clone https://github.com/naver/yobi.git
 
 
-**You can change branch to master or an other branch. But never install master or an other branch a production server.**
 
+or 
 
+Case2. Just download latest stable release
 
+If you want to download one of the stable releases, you can download a compressed file by clicking the URL below. And then name it a yobi and unzip it.
 
 
-You can also make your own yobi directory in any other place. But in that case, you should add playframework home path to $PATH environment.
 
+    https://github.com/naver/yobi/archive/master.zip
 
+    
+**Caution! in case2, You might come across troubles when you try to upgrade Yobi.**
 
 
+> You can locate your own Yobi directory in any other place. Please note that you must add playframework home path to $PATH environment in that case.
 
 
-### cd to cloned yobi directory
 
+### Change directory to cloned Yobi directory (or cd to your unzipped file directory)
 
 
     cd yobi
 
 
-
 
-### run play framework
 
+### Run play framework
 
 
     ../play
@@ -72,28 +82,48 @@
 
 Required files will be download automatically. In the first time, it may take about 10 min or more.
 
 
 
-### type start command in console
 
+### Type start command in console
 
 
     start -DapplyEvolutions.default=true -Dhttp.port=9000
 
 
 It will downloaded addtional files and compile sources.
 
 
-If you want to run yobi in development mode, use **run**. You can see more detailed errors and can use dynamic compilation.
 
+If you want to run Yobi in development mode, use **run**. You can see more detailed errors and can use dynamic compilation.
 
 
 Also, you can configure start options.
 
 If your system's memory is over than 4G, we recommend to use follow options.
 
 
-
 
     _JAVA_OPTIONS="-Xmx2048m -Xms1024m" play "start -DapplyEvolutions.default=true -Dhttp.port=9000"
 
 
-
 
-### connect with browser
 
+### Connect with browser
 
 
     http://127.0.0.1:9000
 
 
 If you want to change port, check your permission to use 80 port
 
 
-see [http://www.playframework.com/documentation/2.1.1/Production](http://www.playframework.com/documentation/2.1.1/Production)
 
+See [http://www.playframework.com/documentation/2.1.1/Production](http://www.playframework.com/documentation/2.1.1/Production)
 
+
 
+### Upgrade Yobi
 
+
 
+Case1. using git client (recommended)
 
+In installed directory, just type git update command.
 
+
 
+	git pull https://github.com/naver/yobi.git master
 
+
 
+Case2. download zip file
 
+
 
+In installed directory, download latest release file and unzip it.
 
+
 
+	https://github.com/naver/yobi/archive/master.zip
 
+
 
+** Be careful! Don't overwrite or delete `yobi.h2.db` file, `repo` & `uploads` directory! **
 
+
 
+### Backup
 
+
 
+Copy the below file and directories to another place.
 
+
 
+	file: yobi.h2.db
 
+	directory: repo, uploads
 
 
 <br/>
 
 <br/>
@@ -112,10 +142,17 @@
 
 
 Yobi 소개
 
 --
 
-Yobi (구 nFORGE)는 소프트웨어 개발에 필요한 기능들을 사용하기 편리하게 웹으로 묶은 협업 개발 플랫폼입니다. 버그나 이슈을 관리할 수 있는 이슈 트래커, 각종 문서와 정보를 간편하게 공유할 수 있는 게시판, 소스코드의 변경내역을 편리하게 관리할 수 있는 형상관리 툴을 비롯하여 팀 개발을 위한 다양한 기능을 포함하고 있습니다.
 
+Yobi (구 nFORGE)는 협업 개발을 위한 프로젝트 호스팅 SW입니다. 
+
 
+- 버그나 이슈을 관리할 수 있는 이슈 트래커
 
+- 각종 문서와 정보를 간편하게 공유할 수 있는 게시판
 
+- 소스코드의 변경내역을 편리하게 관리할 수 있는 형상관리 도구 git/svn 기본 내장
 
+- 협업개발을 위한 코드 주고받기
 
+
 
+등을 비롯하여 팀 개발을 위한 다양한 기능을 포함하고 있습니다.
 
 
 
-라이센스
 
+라이선스
 
 --
 
 Yobi는 Apache 2.0 라이선스로 제공됩니다.
@@ -148,13 +185,22 @@
 
 
     cd play-2.1.0
 
 
-### yobi 소스 내려 받기
 
+### Yobi 소스 내려 받기
 
 
-    git clone https://github.com/naver/yobi.git -b maint yobi
 
+case1. [git 클라이언트](http://git-scm.com)를 이용한 다운로드 (추천)
 
+    
+    git clone https://github.com/naver/yobi.git
 
+    
+case2. 단순히 최신 안정버전을 내려받고자 할 때는 아래 링크를 이용해서 압축파일을 내려받은 다음 yobi를 폴더이름으로해서 해제합니다.
 
 
-**Production Server 에 설치하시는 경우 반드시 `maint` branch 를 사용하거나 최신 realese 버전을 사용하시기 바랍니다.**
 
+    https://github.com/naver/yobi/archive/master.zip
 
+    
+주의! case2의 경우, 업그레이드를 할 때 문제가 생길 수 있습니다.
 
 
-### clone 받은 yobi 디렉터리로 이동
 
+> 임의의 장소에 Yobi 디렉터리를 위치시킬 경우에는 play 실행파일이 있는 playframework 디렉터리를 $PATH 환경변수에 추가해 주세요.
 
+
 
+### clone 받은 Yobi 디렉터리로 이동 
+(혹은 압축을 해제한 디렉터리로 이동)
 
 
     cd yobi
@@ -178,13 +224,35 @@
 
 시작 옵션은 조정가능합니다. 만약 시스템 메모리가 4기가 이상이라면
 
 아래 옵션으로 실행하는걸 권장합니다.
 
 
-
 
     _JAVA_OPTIONS="-Xmx2048m -Xms1024m" play "start -DapplyEvolutions.default=true -Dhttp.port=9000"
 
-
 
+    
 
 ### 브라우저로 접속
 
 
     http://127.0.0.1:9000
 
 
 80 포트 등으로 포트를 변경하고 싶을 경우에는 해당 포트가 사용가능한지 확인 한 다음 80 포트를 사용할 수 있는 계정으로 실행합니다.
 
-관련해서는 [http://www.playframework.com/documentation/2.1.1/Production](http://www.playframework.com/documentation/2.1.1/Production) 부분을 확인해 주세요.
(No newline at end of file) 
+관련해서는 [http://www.playframework.com/documentation/2.1.1/Production](http://www.playframework.com/documentation/2.1.1/Production) 부분을 확인해 주세요.
 
+
 
+### 업그레이드 하기
 
+
 
+case1. git 클라이언트를 이용 (추천)
 
+설치된 디렉터리에서, 아래와 같은 git 명령어를 이용합니다
 
+
 
+	git pull https://github.com/naver/yobi.git master
 
+
 
+case2. 압축파일을 내려받을 경우
 
+
 
+설치된 디렉터리에서, 최신 릴리즈의 압축파일을 내려받아 Yobi가 설치된 디렉터리에 압축파일을 풉니다.
 
+
 
+	https://github.com/naver/yobi/archive/master.zip
 
+
 
+**주의사항! `yobi.h2.db` 파일, `repo`와 `uploads` 디렉터리를 삭제하거나 덮어쓰지 않도록 주의하세요!**
 
+
 
+
 
+### 백업하기
 
+
 
+특별히 외부 DB를 사용하지 않는다면 아래 내용을 잘 백업해서 보관해 주시면 됩니다.
 
+
 
+	file: yobi.h2.db
 
+	directory: repo, uploads
Add a comment
List