diff --git a/README.md b/README.md index 1617226..d43c6aa 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,40 @@ # .github -Shared configuration for OpenArkStudio repositories. +[简体中文](README_CN.md) + +

+ + + OpenArkStudio + +

+ +Organization profile, shared visual assets and repository configuration for +[OpenArkStudio](https://github.com/OpenArkStudio). + +## Organization profile + +- [English profile](profile/README.md): displayed on the public organization page. +- [中文介绍](profile/README_CN.md): Chinese version of the organization profile. + +## Visual identity + +OpenArkStudio, ark and arknet share a cradle hull and Inter 600 lettering in electric blue and cyan. The organization carries one dot, ark carries three modules, and arknet carries linked nodes. The selected horizontal lockup gives the symbol slightly more emphasis; all lettering uses vector outlines. + +All brand SVG masters are archived in this repository's [`assets/`](assets/) directory. Project READMEs reference these files; documentation sites retain matching local copies. + +| Asset | Use | +| :--- | :--- | +| [Organization icon](assets/openarkstudio-icon.svg) | Organization avatar and compact placements | +| [Organization lockup](assets/openarkstudio-logo-light.svg) | Light backgrounds | +| [ark lockup](assets/ark-logo-light.svg) | Framework README and documentation | +| [arknet lockup](assets/arknet-logo-light.svg) | Networking README and documentation | +| [Dark overview](assets/identity-overview-dark.png) | Dark backgrounds | +| [Brand guide](assets/README.md) | File names, colors and usage | + +Preserve the original proportions and choose the `light`, `dark` or `mono` version for the background. See [Inter-OFL.txt](assets/Inter-OFL.txt) for the font license. + +## Shared configuration - ARK and arknet summarize GitHub Actions results in Discord after each workflow completes. - The Webhook is stored in the organization Actions secret `DISCORD_WEBHOOK_URL`. diff --git a/README_CN.md b/README_CN.md new file mode 100644 index 0000000..da8d235 --- /dev/null +++ b/README_CN.md @@ -0,0 +1,40 @@ +# .github + +[English](README.md) + +

+ + + OpenArkStudio + +

+ +本仓库维护 [OpenArkStudio](https://github.com/OpenArkStudio) 的组织主页、视觉资源和共享仓库配置。 + +## 组织主页 + +- [英文介绍](profile/README.md)：显示在 GitHub 组织首页。 +- [中文介绍](profile/README_CN.md)：与英文主页保持一致。 + +## 视觉标识 + +组织、ark 和 arknet 采用「承托」舟体与 Inter 600 字标，使用电蓝和亮青配色。组织图标带一个圆点，ark 带三个模块，arknet 带连接节点。正式组合采用「图形稍强」比例；文字均已转换为矢量路径。 + +所有品牌 SVG 统一保存在本仓库的 [`assets/`](assets/) 目录。项目 README 引用这里的资源，文档站保留相同文件的本地副本。 + +| 资源 | 用途 | +| :--- | :--- | +| [组织图标](assets/openarkstudio-icon.svg) | 组织头像与紧凑布局 | +| [组织组合标](assets/openarkstudio-logo-light.svg) | 浅色背景 | +| [ark 组合标](assets/ark-logo-light.svg) | 框架 README 与文档站 | +| [arknet 组合标](assets/arknet-logo-light.svg) | 网络库 README 与文档站 | +| [深色效果](assets/identity-overview-dark.png) | 深色背景 | +| [品牌说明](assets/README_CN.md) | 文件命名、配色与使用方式 | + +使用时保持原始比例，根据背景选择 `light`、`dark` 或 `mono` 版本。Inter 字体许可见 [Inter-OFL.txt](assets/Inter-OFL.txt)。 + +## 共享配置 + +- ark 和 arknet 在 GitHub Actions 工作流结束后，将结果摘要发送至 Discord。 +- Webhook 保存在组织 Actions secret `DISCORD_WEBHOOK_URL` 中。 +- [通知配置](docs/discord_CN.md) · [English](docs/discord.md) diff --git a/assets/Inter-OFL.txt b/assets/Inter-OFL.txt new file mode 100644 index 0000000..21f6aff --- /dev/null +++ b/assets/Inter-OFL.txt @@ -0,0 +1,93 @@ +Copyright 2020 The Inter Project Authors (https://github.com/rsms/inter) + +This Font Software is licensed under the SIL Open Font License, Version 1.1. +This license is copied below, and is also available with a FAQ at: +https://scripts.sil.org/OFL + + +----------------------------------------------------------- +SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007 +----------------------------------------------------------- + +PREAMBLE +The goals of the Open Font License (OFL) are to stimulate worldwide +development of collaborative font projects, to support the font creation +efforts of academic and linguistic communities, and to provide a free and +open framework in which fonts may be shared and improved in partnership +with others. + +The OFL allows the licensed fonts to be used, studied, modified and +redistributed freely as long as they are not sold by themselves. The +fonts, including any derivative works, can be bundled, embedded, +redistributed and/or sold with any software provided that any reserved +names are not used by derivative works. The fonts and derivatives, +however, cannot be released under any other type of license. The +requirement for fonts to remain under this license does not apply +to any document created using the fonts or their derivatives. + +DEFINITIONS +"Font Software" refers to the set of files released by the Copyright +Holder(s) under this license and clearly marked as such. This may +include source files, build scripts and documentation. + +"Reserved Font Name" refers to any names specified as such after the +copyright statement(s). + +"Original Version" refers to the collection of Font Software components as +distributed by the Copyright Holder(s). + +"Modified Version" refers to any derivative made by adding to, deleting, +or substituting -- in part or in whole -- any of the components of the +Original Version, by changing formats or by porting the Font Software to a +new environment. + +"Author" refers to any designer, engineer, programmer, technical +writer or other person who contributed to the Font Software. + +PERMISSION & CONDITIONS +Permission is hereby granted, free of charge, to any person obtaining +a copy of the Font Software, to use, study, copy, merge, embed, modify, +redistribute, and sell modified and unmodified copies of the Font +Software, subject to the following conditions: + +1) Neither the Font Software nor any of its individual components, +in Original or Modified Versions, may be sold by itself. + +2) Original or Modified Versions of the Font Software may be bundled, +redistributed and/or sold with any software, provided that each copy +contains the above copyright notice and this license. These can be +included either as stand-alone text files, human-readable headers or +in the appropriate machine-readable metadata fields within text or +binary files as long as those fields can be easily viewed by the user. + +3) No Modified Version of the Font Software may use the Reserved Font +Name(s) unless explicit written permission is granted by the corresponding +Copyright Holder. This restriction only applies to the primary font name as +presented to the users. + +4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font +Software shall not be used to promote, endorse or advertise any +Modified Version, except to acknowledge the contribution(s) of the +Copyright Holder(s) and the Author(s) or with their explicit written +permission. + +5) The Font Software, modified or unmodified, in part or in whole, +must be distributed entirely under this license, and must not be +distributed under any other license. The requirement for fonts to +remain under this license does not apply to any document created +using the Font Software. + +TERMINATION +This license becomes null and void if any of the above conditions are +not met. + +DISCLAIMER +THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT +OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE +COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, +INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL +DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING +FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM +OTHER DEALINGS IN THE FONT SOFTWARE. diff --git a/assets/README.md b/assets/README.md new file mode 100644 index 0000000..3128bef --- /dev/null +++ b/assets/README.md @@ -0,0 +1,36 @@ +# OpenArkStudio visual assets + +[简体中文](README_CN.md) + +The selected identity combines the cradle symbol with Inter 600 lettering and electric blue / cyan. OpenArkStudio uses one dot, ark uses three modules, and arknet uses linked nodes. + +The horizontal lockup uses the selected **symbol emphasis** proportions: hull height 88, lowercase x-height 80, and a visible gap of 40 units. The organization symbol has a 17.6-unit optical lift beside the two-line OpenArk / STUDIO lettering. + +![Selected identity](identity-overview.png) + +## Files + +Replace `{brand}` with `openarkstudio`, `ark` or `arknet`. + +| File | Use | +| --- | --- | +| `{brand}-logo-light.svg` | Symbol and lettering on light backgrounds | +| `{brand}-logo-dark.svg` | Symbol and lettering on dark backgrounds | +| `{brand}-logo-mono.svg` | Single-color horizontal lockup | +| `{brand}-icon.svg` | Standalone symbol | +| `{brand}-icon-dark.svg`, `{brand}-icon-mono.svg` | Dark and single-color symbols | +| `{brand}-wordmark-light.svg`, `-dark.svg`, `-mono.svg` | Lettering without a symbol | +| `{brand}-avatar.png` | 512 × 512 transparent PNG | +| `{brand}-social-preview.svg`, `.png` | 1280 × 640 GitHub link-sharing card | +| `identity.json` | Selected proportions, palette and font metadata | + +All 27 identity SVGs have transparent backgrounds, accessible titles and outlined lettering. The three sharing-card SVGs use a light background and outlined captions. None require installed fonts or external font requests. + +## Colors and placement + +- Light backgrounds: blue `#1464F4`, cyan `#06BBDD`, text `#11213B`. +- Dark backgrounds: blue `#508AFF`, cyan `#2CD6EE`, text `#F2F7FF`; preview background `#101D34`. +- Preserve the SVG aspect ratio. In READMEs, set the width and allow the height to follow automatically. +- Reference these masters from project READMEs. Local documentation-site copies must match the archived files. + +Inter is distributed under the [SIL Open Font License](Inter-OFL.txt). Its font source is the [Google Fonts Inter directory](https://github.com/google/fonts/tree/main/ofl/inter). diff --git a/assets/README_CN.md b/assets/README_CN.md new file mode 100644 index 0000000..2c5097a --- /dev/null +++ b/assets/README_CN.md @@ -0,0 +1,36 @@ +# OpenArkStudio 视觉资源 + +[English](README.md) + +正式标识采用承托舟体、Inter 600 字标与电蓝、亮青配色。组织图标带一个圆点，ark 带三个模块，arknet 带连接节点。 + +已选定「图形稍强」比例：舟体高度 88、小写 x-height 80、可见图文间隔 40 单位。组织图标上提 17.6 单位，与 OpenArk / STUDIO 双行字标做光学对齐。 + +![选定标识](identity-overview.png) + +## 文件 + +将 `{brand}` 替换为 `openarkstudio`、`ark` 或 `arknet`。 + +| 文件 | 用途 | +| --- | --- | +| `{brand}-logo-light.svg` | 浅色背景组合标 | +| `{brand}-logo-dark.svg` | 深色背景组合标 | +| `{brand}-logo-mono.svg` | 单色组合标 | +| `{brand}-icon.svg` | 独立图标 | +| `{brand}-icon-dark.svg`、`{brand}-icon-mono.svg` | 深色与单色图标 | +| `{brand}-wordmark-light.svg`、`-dark.svg`、`-mono.svg` | 不带图标的纯字标 | +| `{brand}-avatar.png` | 512 × 512 透明 PNG | +| `{brand}-social-preview.svg`、`.png` | 1280 × 640 GitHub 分享卡片 | +| `identity.json` | 选定比例、配色与字体元数据 | + +27 个标识 SVG 均为透明背景，含可访问标题，文字已转为路径。另有三张浅色背景的分享卡片，说明文字也已转为路径。所有 SVG 均不依赖已安装字体或外部字体请求。 + +## 配色与布局 + +- 浅色背景：电蓝 `#1464F4`、亮青 `#06BBDD`、文字 `#11213B`。 +- 深色背景：蓝色 `#508AFF`、青色 `#2CD6EE`、文字 `#F2F7FF`；预览底色为 `#101D34`。 +- 保持 SVG 原始宽高比。README 中设置宽度，让高度自动适配。 +- 项目 README 引用本目录中的正式资源，文档站本地副本需与归档文件一致。 + +Inter 使用 [SIL Open Font License](Inter-OFL.txt)，字体来源为 [Google Fonts Inter 目录](https://github.com/google/fonts/tree/main/ofl/inter)。 diff --git a/assets/ark-avatar.png b/assets/ark-avatar.png new file mode 100644 index 0000000..f6680ab Binary files /dev/null and b/assets/ark-avatar.png differ diff --git a/assets/ark-icon-dark.svg b/assets/ark-icon-dark.svg new file mode 100644 index 0000000..262291f --- /dev/null +++ b/assets/ark-icon-dark.svg @@ -0,0 +1 @@ +arkSelected cradle direction with Inter 600; visible contours determine scale, gap and baseline. diff --git a/assets/ark-icon-mono.svg b/assets/ark-icon-mono.svg new file mode 100644 index 0000000..95a75c8 --- /dev/null +++ b/assets/ark-icon-mono.svg @@ -0,0 +1 @@ +arkSelected cradle direction with Inter 600; visible contours determine scale, gap and baseline. diff --git a/assets/ark-icon.svg b/assets/ark-icon.svg new file mode 100644 index 0000000..ea26742 --- /dev/null +++ b/assets/ark-icon.svg @@ -0,0 +1 @@ +arkSelected cradle direction with Inter 600; visible contours determine scale, gap and baseline. diff --git a/assets/ark-logo-dark.svg b/assets/ark-logo-dark.svg new file mode 100644 index 0000000..a727110 --- /dev/null +++ b/assets/ark-logo-dark.svg @@ -0,0 +1 @@ +arkSelected cradle direction with Inter 600; visible contours determine scale, gap and baseline. diff --git a/assets/ark-logo-light.svg b/assets/ark-logo-light.svg new file mode 100644 index 0000000..ce6aaa3 --- /dev/null +++ b/assets/ark-logo-light.svg @@ -0,0 +1 @@ +arkSelected cradle direction with Inter 600; visible contours determine scale, gap and baseline. diff --git a/assets/ark-logo-mono.svg b/assets/ark-logo-mono.svg new file mode 100644 index 0000000..4b0f63f --- /dev/null +++ b/assets/ark-logo-mono.svg @@ -0,0 +1 @@ +arkSelected cradle direction with Inter 600; visible contours determine scale, gap and baseline. diff --git a/assets/ark-social-preview.png b/assets/ark-social-preview.png new file mode 100644 index 0000000..4ec091d Binary files /dev/null and b/assets/ark-social-preview.png differ diff --git a/assets/ark-social-preview.svg b/assets/ark-social-preview.svg new file mode 100644 index 0000000..61b578b --- /dev/null +++ b/assets/ark-social-preview.svg @@ -0,0 +1 @@ +ark social preview diff --git a/assets/ark-wordmark-dark.svg b/assets/ark-wordmark-dark.svg new file mode 100644 index 0000000..cee75b6 --- /dev/null +++ b/assets/ark-wordmark-dark.svg @@ -0,0 +1 @@ +arkSelected cradle direction with Inter 600; visible contours determine scale, gap and baseline. diff --git a/assets/ark-wordmark-light.svg b/assets/ark-wordmark-light.svg new file mode 100644 index 0000000..d6ee2ef --- /dev/null +++ b/assets/ark-wordmark-light.svg @@ -0,0 +1 @@ +arkSelected cradle direction with Inter 600; visible contours determine scale, gap and baseline. diff --git a/assets/ark-wordmark-mono.svg b/assets/ark-wordmark-mono.svg new file mode 100644 index 0000000..d6ee2ef --- /dev/null +++ b/assets/ark-wordmark-mono.svg @@ -0,0 +1 @@ +arkSelected cradle direction with Inter 600; visible contours determine scale, gap and baseline. diff --git a/assets/arknet-avatar.png b/assets/arknet-avatar.png new file mode 100644 index 0000000..d5aa8ca Binary files /dev/null and b/assets/arknet-avatar.png differ diff --git a/assets/arknet-icon-dark.svg b/assets/arknet-icon-dark.svg new file mode 100644 index 0000000..effaab9 --- /dev/null +++ b/assets/arknet-icon-dark.svg @@ -0,0 +1 @@ +arknetSelected cradle direction with Inter 600; visible contours determine scale, gap and baseline. diff --git a/assets/arknet-icon-mono.svg b/assets/arknet-icon-mono.svg new file mode 100644 index 0000000..2ac2ac0 --- /dev/null +++ b/assets/arknet-icon-mono.svg @@ -0,0 +1 @@ +arknetSelected cradle direction with Inter 600; visible contours determine scale, gap and baseline. diff --git a/assets/arknet-icon.svg b/assets/arknet-icon.svg new file mode 100644 index 0000000..fdc7cc1 --- /dev/null +++ b/assets/arknet-icon.svg @@ -0,0 +1 @@ +arknetSelected cradle direction with Inter 600; visible contours determine scale, gap and baseline. diff --git a/assets/arknet-logo-dark.svg b/assets/arknet-logo-dark.svg new file mode 100644 index 0000000..accd89a --- /dev/null +++ b/assets/arknet-logo-dark.svg @@ -0,0 +1 @@ +arknetSelected cradle direction with Inter 600; visible contours determine scale, gap and baseline. diff --git a/assets/arknet-logo-light.svg b/assets/arknet-logo-light.svg new file mode 100644 index 0000000..271bcbc --- /dev/null +++ b/assets/arknet-logo-light.svg @@ -0,0 +1 @@ +arknetSelected cradle direction with Inter 600; visible contours determine scale, gap and baseline. diff --git a/assets/arknet-logo-mono.svg b/assets/arknet-logo-mono.svg new file mode 100644 index 0000000..6cc36a7 --- /dev/null +++ b/assets/arknet-logo-mono.svg @@ -0,0 +1 @@ +arknetSelected cradle direction with Inter 600; visible contours determine scale, gap and baseline. diff --git a/assets/arknet-social-preview.png b/assets/arknet-social-preview.png new file mode 100644 index 0000000..a1cc9a0 Binary files /dev/null and b/assets/arknet-social-preview.png differ diff --git a/assets/arknet-social-preview.svg b/assets/arknet-social-preview.svg new file mode 100644 index 0000000..9c297c7 --- /dev/null +++ b/assets/arknet-social-preview.svg @@ -0,0 +1 @@ +arknet social preview diff --git a/assets/arknet-wordmark-dark.svg b/assets/arknet-wordmark-dark.svg new file mode 100644 index 0000000..8865cbe --- /dev/null +++ b/assets/arknet-wordmark-dark.svg @@ -0,0 +1 @@ +arknetSelected cradle direction with Inter 600; visible contours determine scale, gap and baseline. diff --git a/assets/arknet-wordmark-light.svg b/assets/arknet-wordmark-light.svg new file mode 100644 index 0000000..741e8bd --- /dev/null +++ b/assets/arknet-wordmark-light.svg @@ -0,0 +1 @@ +arknetSelected cradle direction with Inter 600; visible contours determine scale, gap and baseline. diff --git a/assets/arknet-wordmark-mono.svg b/assets/arknet-wordmark-mono.svg new file mode 100644 index 0000000..741e8bd --- /dev/null +++ b/assets/arknet-wordmark-mono.svg @@ -0,0 +1 @@ +arknetSelected cradle direction with Inter 600; visible contours determine scale, gap and baseline. diff --git a/assets/identity-overview-dark.png b/assets/identity-overview-dark.png new file mode 100644 index 0000000..625795d Binary files /dev/null and b/assets/identity-overview-dark.png differ diff --git a/assets/identity-overview.png b/assets/identity-overview.png new file mode 100644 index 0000000..fce4e3e Binary files /dev/null and b/assets/identity-overview.png differ diff --git a/assets/identity.json b/assets/identity.json new file mode 100644 index 0000000..7a566bb --- /dev/null +++ b/assets/identity.json @@ -0,0 +1,73 @@ +{ + "profile": "03-symbol", + "font": { + "family": "Inter", + "weight": 600, + "opticalSize": 24 + }, + "palette": { + "id": "electric", + "name": "电蓝与亮青", + "primary": "#1464F4", + "accent": "#06BBDD", + "ink": "#11213B", + "darkPrimary": "#508AFF", + "darkAccent": "#2CD6EE", + "darkInk": "#F2F7FF" + }, + "dimensions": { + "openarkstudio": { + "width": 666, + "height": 224, + "iconLeft": 28, + "iconRight": 190.7169811320755, + "textLeft": 230.7169811320755, + "textTop": 46.72768456375839, + "baseline": 168, + "hullTop": 62.4, + "hullHeight": 88, + "xHeight": 80, + "gap": 40, + "symbolScale": 0.8301886792452831, + "opticalY": -17.6, + "iconBaseline": 150.4 + }, + "ark": { + "width": 477, + "height": 224, + "iconLeft": 28, + "iconRight": 190.7169811320755, + "textLeft": 230.7169811320755, + "textTop": 56.57818265682657, + "baseline": 168, + "hullTop": 80, + "hullHeight": 88, + "xHeight": 80, + "gap": 40, + "symbolScale": 0.8301886792452831, + "opticalY": 0, + "iconBaseline": 168 + }, + "arknet": { + "width": 702, + "height": 224, + "iconLeft": 28, + "iconRight": 190.7169811320755, + "textLeft": 230.7169811320755, + "textTop": 56.312961254612546, + "baseline": 168, + "hullTop": 80, + "hullHeight": 88, + "xHeight": 80, + "gap": 40, + "symbolScale": 0.8301886792452831, + "opticalY": 0, + "iconBaseline": 168 + } + }, + "heroWidths": { + "openarkstudio": 428, + "ark": 307, + "arknet": 451 + } +} diff --git a/assets/openarkstudio-avatar.png b/assets/openarkstudio-avatar.png new file mode 100644 index 0000000..b0ae398 Binary files /dev/null and b/assets/openarkstudio-avatar.png differ diff --git a/assets/openarkstudio-icon-dark.svg b/assets/openarkstudio-icon-dark.svg new file mode 100644 index 0000000..6eeb57c --- /dev/null +++ b/assets/openarkstudio-icon-dark.svg @@ -0,0 +1 @@ +OpenArkStudioSelected cradle direction with Inter 600; visible contours determine scale, gap and baseline. diff --git a/assets/openarkstudio-icon-mono.svg b/assets/openarkstudio-icon-mono.svg new file mode 100644 index 0000000..237118a --- /dev/null +++ b/assets/openarkstudio-icon-mono.svg @@ -0,0 +1 @@ +OpenArkStudioSelected cradle direction with Inter 600; visible contours determine scale, gap and baseline. diff --git a/assets/openarkstudio-icon.svg b/assets/openarkstudio-icon.svg new file mode 100644 index 0000000..d0a4226 --- /dev/null +++ b/assets/openarkstudio-icon.svg @@ -0,0 +1 @@ +OpenArkStudioSelected cradle direction with Inter 600; visible contours determine scale, gap and baseline. diff --git a/assets/openarkstudio-logo-dark.svg b/assets/openarkstudio-logo-dark.svg new file mode 100644 index 0000000..499c823 --- /dev/null +++ b/assets/openarkstudio-logo-dark.svg @@ -0,0 +1 @@ +OpenArkStudioSelected cradle direction with Inter 600; visible contours determine scale, gap and baseline. diff --git a/assets/openarkstudio-logo-light.svg b/assets/openarkstudio-logo-light.svg new file mode 100644 index 0000000..59df401 --- /dev/null +++ b/assets/openarkstudio-logo-light.svg @@ -0,0 +1 @@ +OpenArkStudioSelected cradle direction with Inter 600; visible contours determine scale, gap and baseline. diff --git a/assets/openarkstudio-logo-mono.svg b/assets/openarkstudio-logo-mono.svg new file mode 100644 index 0000000..71b2089 --- /dev/null +++ b/assets/openarkstudio-logo-mono.svg @@ -0,0 +1 @@ +OpenArkStudioSelected cradle direction with Inter 600; visible contours determine scale, gap and baseline. diff --git a/assets/openarkstudio-social-preview.png b/assets/openarkstudio-social-preview.png new file mode 100644 index 0000000..77e3360 Binary files /dev/null and b/assets/openarkstudio-social-preview.png differ diff --git a/assets/openarkstudio-social-preview.svg b/assets/openarkstudio-social-preview.svg new file mode 100644 index 0000000..d0e9835 --- /dev/null +++ b/assets/openarkstudio-social-preview.svg @@ -0,0 +1 @@ +openarkstudio social preview diff --git a/assets/openarkstudio-wordmark-dark.svg b/assets/openarkstudio-wordmark-dark.svg new file mode 100644 index 0000000..7183854 --- /dev/null +++ b/assets/openarkstudio-wordmark-dark.svg @@ -0,0 +1 @@ +OpenArkStudioSelected cradle direction with Inter 600; visible contours determine scale, gap and baseline. diff --git a/assets/openarkstudio-wordmark-light.svg b/assets/openarkstudio-wordmark-light.svg new file mode 100644 index 0000000..192d559 --- /dev/null +++ b/assets/openarkstudio-wordmark-light.svg @@ -0,0 +1 @@ +OpenArkStudioSelected cradle direction with Inter 600; visible contours determine scale, gap and baseline. diff --git a/assets/openarkstudio-wordmark-mono.svg b/assets/openarkstudio-wordmark-mono.svg new file mode 100644 index 0000000..192d559 --- /dev/null +++ b/assets/openarkstudio-wordmark-mono.svg @@ -0,0 +1 @@ +OpenArkStudioSelected cradle direction with Inter 600; visible contours determine scale, gap and baseline. diff --git a/profile/README.md b/profile/README.md new file mode 100644 index 0000000..8a8c4f9 --- /dev/null +++ b/profile/README.md @@ -0,0 +1,50 @@ +

English · 简体中文

+ +

+ + + OpenArkStudio + +

+ +

C++ building blocks for networked applications.

+ +

Compose services. Connect systems. Build in the open.

+ +

+ ark   ·   + arknet   ·   + Framework docs   ·   + Networking docs +

+ +--- + +OpenArkStudio develops open-source libraries and frameworks for C++ server applications, +including game servers. Our core projects focus on modular services, asynchronous +networking and cross-platform development on Linux, macOS and Windows. + +## Choose your starting point + +| Project | What it provides | Start here | +| :--- | :--- | :--- | +| **[ark](https://github.com/OpenArkStudio/ark)** | A C++20 application framework with plugins, module lifecycles, entity data and process communication. | [Quick start](https://openarkstudio.github.io/ark/get-started/quick-start/) · [Examples](https://github.com/OpenArkStudio/ark/tree/main/examples) | +| **[arknet](https://github.com/OpenArkStudio/arknet)** | A C++20 header-only library for TCP, UDP, HTTP, WebSocket, reliable UDP and native MySQL/Redis clients, with optional secure transports. | [Installation](https://openarkstudio.github.io/arknet/get-started/installation/) · [Examples](https://github.com/OpenArkStudio/arknet/tree/main/examples) | + +Use **ark** when you need an application framework to organize services and data. +Use **arknet** when you need networking or database clients in your own application. +ark uses arknet for networking; arknet can also be used independently. + +## Explore and contribute + +- **Learn:** follow the [ark guides](https://openarkstudio.github.io/ark/) or [arknet protocol guides](https://openarkstudio.github.io/arknet/). Both documentation sites are available in English and Chinese. +- **Report a problem:** open an issue in [ark](https://github.com/OpenArkStudio/ark/issues) or [arknet](https://github.com/OpenArkStudio/arknet/issues), with the platform, revision and a reproducible example. +- **Contribute:** improve examples, documentation, tests or implementation. Check the target repository's contributor instructions before opening a pull request. +- **Discuss:** join [Discord](https://discord.gg/GmyBbcv) or start with an issue in the relevant repository. + +## Project licenses + +[ark](https://github.com/OpenArkStudio/ark/blob/main/LICENSE) uses Apache-2.0. +[arknet](https://github.com/OpenArkStudio/arknet/blob/main/LICENSE) uses BSL-1.0 +(Boost Software License 1.0). Other repositories carry their own licenses and +third-party notices. diff --git a/profile/README_CN.md b/profile/README_CN.md new file mode 100644 index 0000000..149656d --- /dev/null +++ b/profile/README_CN.md @@ -0,0 +1,44 @@ +

简体中文 · English

+ +

+ + + OpenArkStudio + +

+ +

面向联网应用的 C++ 基础组件。

+ +

组合业务服务，连接应用系统，开放协作开发。

+ +

+ ark   ·   + arknet   ·   + 框架文档   ·   + 网络库文档 +

+ +--- + +OpenArkStudio 为 C++ 服务端应用开发开源库与框架，应用场景包括游戏服务端。核心项目围绕模块化服务、异步网络与跨平台开发，支持 Linux、macOS 和 Windows。 + +## 选择起点 + +| 项目 | 提供什么 | 从这里开始 | +| :--- | :--- | :--- | +| **[ark](https://github.com/OpenArkStudio/ark)** | C++20 应用框架，提供插件、模块生命周期、实体数据与进程通信。 | [快速开始](https://openarkstudio.github.io/ark/zh/get-started/quick-start/) · [示例](https://github.com/OpenArkStudio/ark/tree/main/examples) | +| **[arknet](https://github.com/OpenArkStudio/arknet)** | C++20 header-only 库，提供 TCP、UDP、HTTP、WebSocket、可靠 UDP、原生 MySQL/Redis 客户端及可选的安全传输。 | [安装与配置](https://openarkstudio.github.io/arknet/zh/get-started/installation/) · [示例](https://github.com/OpenArkStudio/arknet/tree/main/examples) | + +需要应用框架来组织服务和数据时，从 **ark** 开始。需要在自己的应用中使用网络或数据库客户端时，从 **arknet** 开始。ark 使用 arknet 提供网络能力，arknet 也可独立使用。 + +## 了解与参与 + +- **阅读文档**：从 [ark 指南](https://openarkstudio.github.io/ark/zh/)或 [arknet 协议指南](https://openarkstudio.github.io/arknet/zh/)开始。两个文档站均提供中英文版本。 +- **反馈问题**：在 [ark](https://github.com/OpenArkStudio/ark/issues) 或 [arknet](https://github.com/OpenArkStudio/arknet/issues) 提交 Issue，附上平台、提交版本和可复现示例。 +- **参与贡献**：改进示例、文档、测试或实现。提交 PR 前，请阅读目标仓库的贡献说明。 +- **交流讨论**：加入 [Discord](https://discord.gg/GmyBbcv)，或在相关仓库提交 Issue。 + +## 项目许可证 + +[ark](https://github.com/OpenArkStudio/ark/blob/main/LICENSE) 采用 Apache-2.0。 +[arknet](https://github.com/OpenArkStudio/arknet/blob/main/LICENSE) 采用 BSL-1.0（Boost Software License 1.0）。其他仓库的许可证及第三方声明以各仓库内容为准。