From a89944f792ccad428425a572cced6e3b753c731a Mon Sep 17 00:00:00 2001 From: Kazuhito Suda Date: Sat, 9 Sep 2023 14:59:50 +0900 Subject: [PATCH] ADD documentation --- CHANGELOG.md | 1 + README.md | 13 +++++++++++-- README_ja.md | 11 ++++++++++- docs/en/index.md | 11 ++++++++++- docs/ja/index.md | 11 ++++++++++- 5 files changed, 42 insertions(+), 5 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index c0b0606..10d8f3e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,6 @@ ## FIWARE Small Bang v0.0.1-next +- ADD documentation - ADD unit test ## FIWARE Small Bang v0.0.1 - 9 Sep, 2023 diff --git a/README.md b/README.md index 60a8a28..975cf9b 100644 --- a/README.md +++ b/README.md @@ -5,13 +5,20 @@ [![License: MIT](https://img.shields.io/github/license/lets-fiware/FIWARE-Small-Bang.svg)](https://opensource.org/licenses/MIT) [![GitHub Discussions](https://img.shields.io/github/discussions/lets-fiware/FIWARE-Small-Bang)](https://github.com/lets-fiware/FIWARE-Small-Bang/discussions)
+[![Lint](https://github.com/lets-fiware/FIWARE-Small-Bang/actions/workflows/lint.yml/badge.svg)](https://github.com/lets-fiware/FIWARE-Small-Bang/actions/workflows/lint.yml) +[![Tests](https://github.com/lets-fiware/FIWARE-Small-Bang/actions/workflows/ubuntu-latest.yml/badge.svg)](https://github.com/lets-fiware/FIWARE-Small-Bang/actions/workflows/ubuntu-latest.yml) +[![codecov](https://codecov.io/gh/lets-fiware/FIWARE-Small-Bang/graph/badge.svg?token=NYMGIUqFlH)](https://codecov.io/gh/lets-fiware/FIWARE-Small-Bang) +
+[![Ubuntu 20.04](https://github.com/lets-fiware/FIWARE-Small-Bang/actions/workflows/ubuntu-20.04.yml/badge.svg)](https://github.com/lets-fiware/FIWARE-Small-Bang/actions/workflows/ubuntu-20.04.yml) +[![Ubuntu 22.04](https://github.com/lets-fiware/FIWARE-Small-Bang/actions/workflows/ubuntu-22.04.yml/badge.svg)](https://github.com/lets-fiware/FIWARE-Small-Bang/actions/workflows/ubuntu-22.04.yml) +
The FIWARE Small Bang is a turnkey solution for setting up a FIWARE instance on your local machine. | :books: [Documentation](https://fi-sb.letsfiware.jp/) | :dart: [Roadmap](./ROADMAP.md) | |-------------------------------------------------------|--------------------------------| -このドキュメントは[日本語](./README.ja.md)でもご覧いただけます。 +このドキュメントは[日本語](./README_ja.md)でもご覧いただけます。 ## What is FIWARE Small Bang? @@ -41,7 +48,7 @@ FI-SB stands for FIWARE Small Bang. ## Requirements - Supported Linux distribution - - Ubuntu 22.04 LTS + - Ubuntu 22.04 LTS (x86_64, Aarch64) - Ubuntu 20.04 LTS - CentOS Stream release 9 - CentOS Stream release 8 @@ -50,6 +57,8 @@ FI-SB stands for FIWARE Small Bang. - AlmaLinux 9 - AlmaLinux 8 +- macOS (Intel, Apple Silicon) + ## Prerequisite Before running the setup script, you need to install docker and docker compose plugin. diff --git a/README_ja.md b/README_ja.md index 0eb50d3..b720c5b 100644 --- a/README_ja.md +++ b/README_ja.md @@ -5,6 +5,13 @@ [![License: MIT](https://img.shields.io/github/license/lets-fiware/FIWARE-Small-Bang.svg)](https://opensource.org/licenses/MIT) [![GitHub Discussions](https://img.shields.io/github/discussions/lets-fiware/FIWARE-Small-Bang)](https://github.com/lets-fiware/FIWARE-Small-Bang/discussions)
+[![Lint](https://github.com/lets-fiware/FIWARE-Small-Bang/actions/workflows/lint.yml/badge.svg)](https://github.com/lets-fiware/FIWARE-Small-Bang/actions/workflows/lint.yml) +[![Tests](https://github.com/lets-fiware/FIWARE-Small-Bang/actions/workflows/ubuntu-latest.yml/badge.svg)](https://github.com/lets-fiware/FIWARE-Small-Bang/actions/workflows/ubuntu-latest.yml) +[![codecov](https://codecov.io/gh/lets-fiware/FIWARE-Small-Bang/graph/badge.svg?token=NYMGIUqFlH)](https://codecov.io/gh/lets-fiware/FIWARE-Small-Bang) +
+[![Ubuntu 20.04](https://github.com/lets-fiware/FIWARE-Small-Bang/actions/workflows/ubuntu-20.04.yml/badge.svg)](https://github.com/lets-fiware/FIWARE-Small-Bang/actions/workflows/ubuntu-20.04.yml) +[![Ubuntu 22.04](https://github.com/lets-fiware/FIWARE-Small-Bang/actions/workflows/ubuntu-22.04.yml/badge.svg)](https://github.com/lets-fiware/FIWARE-Small-Bang/actions/workflows/ubuntu-22.04.yml) +
FIWARE Small Bang は、ローカル・マシンに FIWARE インスタンスをセットアップするためのターンキー・ソリューションです。 @@ -39,7 +46,7 @@ FI-SB は FIWARE Small Bang の略称です。 ## 要件 - サポートしている Linux ディストリビューション - - Ubuntu 22.04 LTS + - Ubuntu 22.04 LTS (x86_64, Aarch64) - Ubuntu 20.04 LTS - CentOS Stream release 9 - CentOS Stream release 8 @@ -48,6 +55,8 @@ FI-SB は FIWARE Small Bang の略称です。 - AlmaLinux 9 - AlmaLinux 8 +- macOS (Intel, Apple Silicon) + ## 前提条件 セットアップ・スクリプトを実行する前に、Docker と Docker compose plugin を導入します。 diff --git a/docs/en/index.md b/docs/en/index.md index 303ce76..910b9c6 100644 --- a/docs/en/index.md +++ b/docs/en/index.md @@ -5,6 +5,13 @@ [![License: MIT](https://img.shields.io/github/license/lets-fiware/FIWARE-Small-Bang.svg)](https://opensource.org/licenses/MIT) [![GitHub Discussions](https://img.shields.io/github/discussions/lets-fiware/FIWARE-Small-Bang)](https://github.com/lets-fiware/FIWARE-Small-Bang/discussions)
+[![Lint](https://github.com/lets-fiware/FIWARE-Small-Bang/actions/workflows/lint.yml/badge.svg)](https://github.com/lets-fiware/FIWARE-Small-Bang/actions/workflows/lint.yml) +[![Tests](https://github.com/lets-fiware/FIWARE-Small-Bang/actions/workflows/ubuntu-latest.yml/badge.svg)](https://github.com/lets-fiware/FIWARE-Small-Bang/actions/workflows/ubuntu-latest.yml) +[![codecov](https://codecov.io/gh/lets-fiware/FIWARE-Small-Bang/graph/badge.svg?token=NYMGIUqFlH)](https://codecov.io/gh/lets-fiware/FIWARE-Small-Bang) +
+[![Ubuntu 20.04](https://github.com/lets-fiware/FIWARE-Small-Bang/actions/workflows/ubuntu-20.04.yml/badge.svg)](https://github.com/lets-fiware/FIWARE-Small-Bang/actions/workflows/ubuntu-20.04.yml) +[![Ubuntu 22.04](https://github.com/lets-fiware/FIWARE-Small-Bang/actions/workflows/ubuntu-22.04.yml/badge.svg)](https://github.com/lets-fiware/FIWARE-Small-Bang/actions/workflows/ubuntu-22.04.yml) +
The FIWARE Small Bang is a turnkey solution for setting up a FIWARE instance on your local machine. @@ -36,7 +43,7 @@ FI-SB stands for FIWARE Small Bang. ## Requirements - Supported Linux distribution - - Ubuntu 22.04 LTS + - Ubuntu 22.04 LTS (x86_64, Aarch64) - Ubuntu 20.04 LTS - CentOS Stream release 9 - CentOS Stream release 8 @@ -45,6 +52,8 @@ FI-SB stands for FIWARE Small Bang. - AlmaLinux 9 - AlmaLinux 8 +- macOS (Intel, Apple Silicon) + ## Prerequisite Before running the setup script, you need to install docker and docker compose plugin. diff --git a/docs/ja/index.md b/docs/ja/index.md index dd48170..adcdb5a 100644 --- a/docs/ja/index.md +++ b/docs/ja/index.md @@ -5,6 +5,13 @@ [![License: MIT](https://img.shields.io/github/license/lets-fiware/FIWARE-Small-Bang.svg)](https://opensource.org/licenses/MIT) [![GitHub Discussions](https://img.shields.io/github/discussions/lets-fiware/FIWARE-Small-Bang)](https://github.com/lets-fiware/FIWARE-Small-Bang/discussions)
+[![Lint](https://github.com/lets-fiware/FIWARE-Small-Bang/actions/workflows/lint.yml/badge.svg)](https://github.com/lets-fiware/FIWARE-Small-Bang/actions/workflows/lint.yml) +[![Tests](https://github.com/lets-fiware/FIWARE-Small-Bang/actions/workflows/ubuntu-latest.yml/badge.svg)](https://github.com/lets-fiware/FIWARE-Small-Bang/actions/workflows/ubuntu-latest.yml) +[![codecov](https://codecov.io/gh/lets-fiware/FIWARE-Small-Bang/graph/badge.svg?token=NYMGIUqFlH)](https://codecov.io/gh/lets-fiware/FIWARE-Small-Bang) +
+[![Ubuntu 20.04](https://github.com/lets-fiware/FIWARE-Small-Bang/actions/workflows/ubuntu-20.04.yml/badge.svg)](https://github.com/lets-fiware/FIWARE-Small-Bang/actions/workflows/ubuntu-20.04.yml) +[![Ubuntu 22.04](https://github.com/lets-fiware/FIWARE-Small-Bang/actions/workflows/ubuntu-22.04.yml/badge.svg)](https://github.com/lets-fiware/FIWARE-Small-Bang/actions/workflows/ubuntu-22.04.yml) +
FIWARE Small Bang は、ローカル・マシンに FIWARE インスタンスをセットアップするためのターンキー・ソリューションです。 @@ -36,7 +43,7 @@ FI-SB は FIWARE Small Bang の略称です。 ## 要件 - サポートしている Linux ディストリビューション - - Ubuntu 22.04 LTS + - Ubuntu 22.04 LTS (x86_64, Aarch64) - Ubuntu 20.04 LTS - CentOS Stream release 9 - CentOS Stream release 8 @@ -45,6 +52,8 @@ FI-SB は FIWARE Small Bang の略称です。 - AlmaLinux 9 - AlmaLinux 8 +- macOS (Intel, Apple Silicon) + ## 前提条件 セットアップ・スクリプトを実行する前に、Docker と Docker compose plugin を導入します。