From a07daf871e35add1224d84e9a4613d879782e109 Mon Sep 17 00:00:00 2001 From: Malix Date: Mon, 27 Jan 2025 16:54:50 +0100 Subject: [PATCH 1/2] docs: enhance directory structure Signed-off-by: Malix --- CODE-OF-CONDUCT.md => docs/CODE-OF-CONDUCT.md | 0 CONTRIBUTING.md => docs/CONTRIBUTING.md | 0 SECURITY.md => docs/SECURITY.md | 0 install.md => docs/install.md | 0 4 files changed, 0 insertions(+), 0 deletions(-) rename CODE-OF-CONDUCT.md => docs/CODE-OF-CONDUCT.md (100%) rename CONTRIBUTING.md => docs/CONTRIBUTING.md (100%) rename SECURITY.md => docs/SECURITY.md (100%) rename install.md => docs/install.md (100%) diff --git a/CODE-OF-CONDUCT.md b/docs/CODE-OF-CONDUCT.md similarity index 100% rename from CODE-OF-CONDUCT.md rename to docs/CODE-OF-CONDUCT.md diff --git a/CONTRIBUTING.md b/docs/CONTRIBUTING.md similarity index 100% rename from CONTRIBUTING.md rename to docs/CONTRIBUTING.md diff --git a/SECURITY.md b/docs/SECURITY.md similarity index 100% rename from SECURITY.md rename to docs/SECURITY.md diff --git a/install.md b/docs/install.md similarity index 100% rename from install.md rename to docs/install.md From 9a57aeb763a1dfba31681cfda2837888b23f1d74 Mon Sep 17 00:00:00 2001 From: Malix Date: Mon, 27 Jan 2025 17:01:15 +0100 Subject: [PATCH 2/2] enhance: merge READMEs Signed-off-by: Malix --- README.md | 66 -------------------------------------------------- docs/README.md | 63 ++++++++++++++++++++++++++++++++++++++++++++++- 2 files changed, 62 insertions(+), 67 deletions(-) delete mode 100644 README.md diff --git a/README.md b/README.md deleted file mode 100644 index eefe11568..000000000 --- a/README.md +++ /dev/null @@ -1,66 +0,0 @@ -## podman-tui - -![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg) -![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/containers/podman-tui) -![Go](https://github.com/containers/podman-tui/workflows/Go/badge.svg) -[![Go Report](https://goreportcard.com/badge/github.com/containers/podman-tui)](https://goreportcard.com/report/github.com/containers/podman-tui) -[![codecov](https://codecov.io/gh/navidys/podman-tui/branch/main/graph/badge.svg)](https://codecov.io/gh/navidys/podman-tui) - -Terminal user interface for Podman environment. - -![Screenshot](./docs/podman-tui.gif) - -- [**Overview**](#overview) -- [**Compatibility Matrix**](#compatibility-matrix) -- [**Installation**](#installation) -- [**PreRun Checks**](#prerun-checks) -- [**Key Bindings**](#key-bindings) -- [**Code of Conduct**](#code-of-conduct) -- [**License**](#license) - -## Overview - -podman-tui is a terminal user interface for podman environment. -It is using [podman go bindings](https://github.com/containers/podman/tree/main/pkg/bindings) to communicate with local or remote podman machine (through SSH). - -## Compatibility matrix - -| Terminal User Interface | Podman | -| ----------- | ------ | -| release-1.x | v5.x.y | -| release-0.x | v4.x.y | - -## Installation - -Building from source (Linux, Windows and MacOS) or installing packaged versions are detailed in [install guide](install.md). - -## PreRun Checks - -* `podman.socket` service needs to be running on podman machine. - The recommended way to start Podman system service in production mode is via systemd socket-activation: - - ```shell - $ systemctl --user start podman.socket - ``` - - See [start podman system service](https://podman.io/blogs/2020/08/10/podman-go-bindings.html) for more details. - -* If the SSH key has a passphrase, then you need to set and export `CONTAINER_PASSPHRASE=` variable. - ```shell - $ export CONTAINER_PASSPHRASE=keypass - ``` - -* podman-tui uses 256 colors terminal mode on `Nix` system and standard ANSI colors on `Windows` system (use "command prompt" application). - - -## Key Bindings - -Check [podman-tui docs](./docs/README.md) for keyboard mappings. - -## Code of Conduct - -This project is using the [Containers Community Code of Conduct](https://github.com/containers/common/blob/main/CODE-OF-CONDUCT.md) - -## License - -Licensed under the [Apache 2.0](LICENSE) license. diff --git a/docs/README.md b/docs/README.md index 4da89bc17..3dc5ced90 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,4 +1,57 @@ -# Documents +## podman-tui + +![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg) +![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/containers/podman-tui) +![Go](https://github.com/containers/podman-tui/workflows/Go/badge.svg) +[![Go Report](https://goreportcard.com/badge/github.com/containers/podman-tui)](https://goreportcard.com/report/github.com/containers/podman-tui) +[![codecov](https://codecov.io/gh/navidys/podman-tui/branch/main/graph/badge.svg)](https://codecov.io/gh/navidys/podman-tui) + +Terminal user interface for Podman environment. + +![Screenshot](./docs/podman-tui.gif) + +- [**Overview**](#overview) +- [**Compatibility Matrix**](#compatibility-matrix) +- [**Installation**](#installation) +- [**PreRun Checks**](#prerun-checks) +- [**Key Bindings**](#key-bindings) +- [**Code of Conduct**](#code-of-conduct) +- [**License**](#license) + +## Overview + +podman-tui is a terminal user interface for podman environment. +It is using [podman go bindings](https://github.com/containers/podman/tree/main/pkg/bindings) to communicate with local or remote podman machine (through SSH). + +## Compatibility matrix + +| Terminal User Interface | Podman | +| ----------- | ------ | +| release-1.x | v5.x.y | +| release-0.x | v4.x.y | + +## Installation + +Building from source (Linux, Windows and MacOS) or installing packaged versions are detailed in [install guide](install.md). + +## PreRun Checks + +* `podman.socket` service needs to be running on podman machine. + The recommended way to start Podman system service in production mode is via systemd socket-activation: + + ```shell + $ systemctl --user start podman.socket + ``` + + See [start podman system service](https://podman.io/blogs/2020/08/10/podman-go-bindings.html) for more details. + +* If the SSH key has a passphrase, then you need to set and export `CONTAINER_PASSPHRASE=` variable. + ```shell + $ export CONTAINER_PASSPHRASE=keypass + ``` + +* podman-tui uses 256 colors terminal mode on `Nix` system and standard ANSI colors on `Windows` system (use "command prompt" application). + ## Key Bindings @@ -27,3 +80,11 @@ podman-tui uses following keyboard keys for different actions: | Display images screen | F6 | | Display networks screen | F7 | | Display secrets screen | F8 | + +## Code of Conduct + +This project is using the [Containers Community Code of Conduct](https://github.com/containers/common/blob/main/CODE-OF-CONDUCT.md) + +## License + +Licensed under the [Apache 2.0](LICENSE) license.