diff options
| author | Shulhan <ms@kilabit.info> | 2024-02-04 21:19:14 +0700 |
|---|---|---|
| committer | Shulhan <ms@kilabit.info> | 2024-02-04 21:19:14 +0700 |
| commit | ef954b5aae36934165103c398b783bac1fb4c911 (patch) | |
| tree | 2c31fbe1a98dac5159961ecd6c685ca3c9b619c3 | |
| parent | 38a175086c9c06845e0248fddcd39a590d323a6e (diff) | |
| download | pakakeh.ts-ef954b5aae36934165103c398b783bac1fb4c911.tar.xz | |
all: rewrite README using markdown format
This is to make the repository README rendered on git.sr.ht, not only
github.
| -rw-r--r-- | .gitignore | 1 | ||||
| -rw-r--r-- | .reuse/dep5 | 4 | ||||
| -rw-r--r-- | README.md (renamed from README.adoc) | 11 |
3 files changed, 9 insertions, 7 deletions
@@ -2,3 +2,4 @@ // SPDX-License-Identifier: GPL-3.0-or-later *.js /node_modules +README.html diff --git a/.reuse/dep5 b/.reuse/dep5 index e30f75c..9541263 100644 --- a/.reuse/dep5 +++ b/.reuse/dep5 @@ -10,3 +10,7 @@ License: GPL-3.0-or-later Files: tsconfig.json Copyright: 2022 Shulhan <ms@kilabit.info> License: GPL-3.0-or-later + +Files: README.md +Copyright: 2021 Shulhan <ms@kilabit.info> +License: GPL-3.0-or-later @@ -1,16 +1,13 @@ -// SPDX-FileCopyrightText: 2021 M. Shulhan <ms@kilabit.info> -// SPDX-License-Identifier: GPL-3.0-or-later -= web-user interface (wui) -Shulhan <ms@kilabit.info> +# web-user interface (wui) A HTML web-user interface components built with TypeScript. -== Coding style +## Coding style * Use snake_case for field, variable, HTML ID, and CSS class names. * Use camelCase for class, interface, type, function, or method names. * An exported type or class. interface, type, method, or function name MUST start with an upper-case letter. -* An exported class, type, interface, or function MUST be prefixed with "Wui". - +* An exported class, type, interface, or function MUST be prefixed with + "Wui". * Use the `WuiResponseInterface` for non-void return type. |