Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 35 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,40 @@
# .github

Shared configuration for OpenArkStudio repositories.
[简体中文](README_CN.md)

<p align="center">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="assets/openarkstudio-logo-dark.svg">
<img src="assets/openarkstudio-logo-light.svg" alt="OpenArkStudio" width="428">
</picture>
</p>

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`.
Expand Down
40 changes: 40 additions & 0 deletions README_CN.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
# .github

[English](README.md)

<p align="center">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="assets/openarkstudio-logo-dark.svg">
<img src="assets/openarkstudio-logo-light.svg" alt="OpenArkStudio" width="428">
</picture>
</p>

本仓库维护 [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)
93 changes: 93 additions & 0 deletions assets/Inter-OFL.txt
Original file line number Diff line number Diff line change
@@ -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.
36 changes: 36 additions & 0 deletions assets/README.md
Original file line number Diff line number Diff line change
@@ -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).
36 changes: 36 additions & 0 deletions assets/README_CN.md
Original file line number Diff line number Diff line change
@@ -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)。
Binary file added assets/ark-avatar.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions assets/ark-icon-dark.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions assets/ark-icon-mono.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions assets/ark-icon.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions assets/ark-logo-dark.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions assets/ark-logo-light.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Loading