Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ADD documentation #3

Merged
merged 1 commit into from
Sep 9, 2023
Merged

ADD documentation #3

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand Down
13 changes: 11 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
<br/>
[![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)
<br/>
[![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)
<br/>

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?

Expand Down Expand Up @@ -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
Expand All @@ -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.
Expand Down
11 changes: 10 additions & 1 deletion README_ja.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
<br/>
[![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)
<br/>
[![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)
<br/>

FIWARE Small Bang は、ローカル・マシンに FIWARE インスタンスをセットアップするためのターンキー・ソリューションです。

Expand Down Expand Up @@ -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
Expand All @@ -48,6 +55,8 @@ FI-SB は FIWARE Small Bang の略称です。
- AlmaLinux 9
- AlmaLinux 8

- macOS (Intel, Apple Silicon)

## 前提条件

セットアップ・スクリプトを実行する前に、Docker と Docker compose plugin を導入します。
Expand Down
11 changes: 10 additions & 1 deletion docs/en/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
<br/>
[![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)
<br/>
[![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)
<br/>

The FIWARE Small Bang is a turnkey solution for setting up a FIWARE instance on your local machine.

Expand Down Expand Up @@ -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
Expand All @@ -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.
Expand Down
11 changes: 10 additions & 1 deletion docs/ja/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
<br/>
[![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)
<br/>
[![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)
<br/>

FIWARE Small Bang は、ローカル・マシンに FIWARE インスタンスをセットアップするためのターンキー・ソリューションです。

Expand Down Expand Up @@ -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
Expand All @@ -45,6 +52,8 @@ FI-SB は FIWARE Small Bang の略称です。
- AlmaLinux 9
- AlmaLinux 8

- macOS (Intel, Apple Silicon)

## 前提条件

セットアップ・スクリプトを実行する前に、Docker と Docker compose plugin を導入します。
Expand Down