diff --git a/README.md b/README.md new file mode 100644 index 000000000..c0ca49971 --- /dev/null +++ b/README.md @@ -0,0 +1,56 @@ +## Aperçu ## + +This unnamed project is to create a side-view flatformer game, an attempt to create friendlier Dwarf Fortress adventurer mode, with more roguelike stuff such as perma-death and randomness and *lots of fun* + +This project mainly uses Kotlin, and Java as sub-language, Python/Lua/etc. for tools. + +Documentations and resources for work (such as .psd) are also included in the repo. You will need Mac computer to read and edit documentations in .gcx and .numbers. + +Any contribution in this project is sorely in English, so be sure to use English in codes, comments, etc. + +## Setup ## + +* Summary of set up +* Configuration +* Dependencies +* Database configuration +* How to run tests +* Deployment instructions + + +## Contribution guidelines ## + +### Contributing code ### + +* Writing tests +* Code review +* Guidelines +Quintessential: write code that an imbecile can understand. + + +### Contributing translations ### + + +* Writing text +You will need to fiddle with .csv files in ./res/locales + + +## Who do I talk to? ## + +* Repo owner or admin +* Other community or team contact + + +## 한국어 개요 ## + +이 변변한 이름 없는 프로젝트는 사이드뷰 발판 게임 형식으로 더 친절한 〈드워프 포트리스〉의 모험가 모드를 지향하는 게임 제작 프로젝트입니다. 영구 사망, 무작위성, __넘쳐나는 재미__와 같이 로그라이크스러운 요소를 지닙니다. + +이 프로젝트는 주 언어로 코틀린, 보조 언어로 자바를 사용하며 파이선·루아 등으로 작성된 툴을 이용합니다. + +문서와 작업용 리소스(psd 등) 또한 이 저장소에 포함되어 있습니다. gcx와 numbers 형식으로 된 문서를 읽고 수정하기 위해 맥 컴퓨터가 필요할 수 있습니다. + +이 프로젝트에 대한 기여는 영어로 이루어져야 합니다. 따라서 코드나 주석 등을 작성할 때는 영어를 사용해 주십시오. + + + +First edit: 2016-03-14T23:06:03+09:00 \ No newline at end of file