From 93ea565bcb1754fdac3c0b6219c24206cadb9851 Mon Sep 17 00:00:00 2001 From: Cloud Wu Date: Mon, 31 Jul 2023 10:19:40 +0800 Subject: [PATCH] Improve README, See #1785 --- README.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 5514756d..d8b19406 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,10 @@ ## ![skynet logo](https://github.com/cloudwu/skynet/wiki/image/skynet_metro.jpg) -Skynet is a lightweight online game framework which can be used in many other fields. +Skynet is a multi-user Lua framework supporting the actor model, often used in games. + +[It is heavily used in the Chinese game industry](https://github.com/cloudwu/skynet/wiki/Uses), but is also now spreading to other industries, and to English-centric developers. To visit related sites, visit the Chinese pages using something like Google or Deepl translate. + +The community is friendly and almost contributors can speak English, so English speakers are welcome to ask questions in [Discussion](https://github.com/cloudwu/skynet/discussions), or sumbit issues in English. ## Build @@ -38,5 +42,5 @@ Official Lua versions can also be used as long as the Makefile is edited. ## How To Use -* Read Wiki for documents https://github.com/cloudwu/skynet/wiki -* The FAQ in wiki https://github.com/cloudwu/skynet/wiki/FAQ +* Read Wiki for documents https://github.com/cloudwu/skynet/wiki (Written in both English and Chinese) +* The FAQ in wiki https://github.com/cloudwu/skynet/wiki/FAQ (In Chinese, but you can visit them using something like Google or Deepl translate.)