Elgato_dark/podman-desktop
1
0
Fork 0
mirror of https://github.com/podman-desktop/podman-desktop synced 2026-04-21 17:47:22 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 10
podman-desktop/README.md

126 lines
4.8 KiB
Markdown
Raw Normal View History

chore: apply prettier on .md, .json and .css files Change-Id: Ic08ccbb1f248d07c39cdc768daa3423bfef7e6fc Signed-off-by: Florent Benoit <fbenoit@redhat.com>
2023-06-14 07:59:27 +00:00
# Podman Desktop - A graphical tool for developing on containers and Kubernetes
docs: add license + latest release as GitHub badges in Readme while adding the OpenSSF badge I noticed we were missing 'classic badges' like the license and the latest release one so adding them there Signed-off-by: Florent BENOIT <fbenoit@redhat.com>
2025-01-27 16:42:35 +00:00
![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)
![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/podman-desktop/podman-desktop)
chore: add OpenSSF badge related to https://github.com/podman-desktop/podman-desktop/issues/10833 Signed-off-by: Florent BENOIT <fbenoit@redhat.com>
2025-01-27 12:43:04 +00:00
[![OpenSSF Best Practices](https://www.bestpractices.dev/projects/9966/badge)](https://www.bestpractices.dev/projects/9966)
docs: fix wording (credits to Gerard) Change-Id: I01c6f7d36ff47d658673853951697df254e6d0d8 Signed-off-by: Florent Benoit <fbenoit@redhat.com>
2022-04-13 11:46:33 +00:00
<p align="center">
fix: image has been renamed fixes https://github.com/containers/podman-desktop/issues/2684 Change-Id: Ide26bba76da7f22089cf421fe19c80b33baea48c Signed-off-by: Florent Benoit <fbenoit@redhat.com>
2023-05-30 08:48:05 +00:00
<img alt="Podman Desktop" src="/website/static/img/features/manage-containers.webp">
docs: fix wording (credits to Gerard) Change-Id: I01c6f7d36ff47d658673853951697df254e6d0d8 Signed-off-by: Florent Benoit <fbenoit@redhat.com>
2022-04-13 11:46:33 +00:00
</p>
docs: update readme / reorganize (#705) * docs: update readme / reorganize ### What does this PR do? Updates the README with the following: * Removes references to OpenShift * Updates the main screenshot * Reorganizes / rewords some parts of the README * Changes the link to download to the website instead of the GitHub release page ### Screenshot/screencast of this PR <!-- Please include a screenshot or a screencast explaining what is doing this PR --> N/A ### What issues does this PR fix or reference? <!-- Please include any related issue from Podman Desktop repository (or from another issue tracker). --> N/A ### How to test this PR? View it :) <!-- Please explain steps to reproduce --> Signed-off-by: Charlie Drage <charlie@charliedrage.com> * update based on review Signed-off-by: Charlie Drage <charlie@charliedrage.com> Signed-off-by: Charlie Drage <charlie@charliedrage.com>
2022-11-07 08:14:08 +00:00
## Documentation
docs: fix wording (credits to Gerard) Change-Id: I01c6f7d36ff47d658673853951697df254e6d0d8 Signed-off-by: Florent Benoit <fbenoit@redhat.com>
2022-04-13 11:46:33 +00:00
- [**Overview**](#overview)
- [**Download**](#download)
docs: quickfix the readme.md (#805) ### What does this PR do? * Fixes the missing section on features * Adds another entry to the TOC * Fixes spacing / newline ### Screenshot/screencast of this PR <!-- Please include a screenshot or a screencast explaining what is doing this PR --> ### What issues does this PR fix or reference? <!-- Please include any related issue from Podman Desktop repository (or from another issue tracker). --> ### How to test this PR? <!-- Please explain steps to reproduce --> Signed-off-by: Charlie Drage <charlie@charliedrage.com> Signed-off-by: Charlie Drage <charlie@charliedrage.com>
2022-11-10 13:53:25 +00:00
- [**Features**](#download)
- [**Join Our Early Adopter Program (Optional)**](#join-our-early-adopter-program-optional)
docs: fix wording (credits to Gerard) Change-Id: I01c6f7d36ff47d658673853951697df254e6d0d8 Signed-off-by: Florent Benoit <fbenoit@redhat.com>
2022-04-13 11:46:33 +00:00
- [**Roadmap**](#roadmap)
- [**Contributing**](#contributing)
- [**Communication**](#communication)
- [**Code of Conduct**](#code-of-conduct)
- [**License**](#license)
docs: update readme / reorganize (#705) * docs: update readme / reorganize ### What does this PR do? Updates the README with the following: * Removes references to OpenShift * Updates the main screenshot * Reorganizes / rewords some parts of the README * Changes the link to download to the website instead of the GitHub release page ### Screenshot/screencast of this PR <!-- Please include a screenshot or a screencast explaining what is doing this PR --> N/A ### What issues does this PR fix or reference? <!-- Please include any related issue from Podman Desktop repository (or from another issue tracker). --> N/A ### How to test this PR? View it :) <!-- Please explain steps to reproduce --> Signed-off-by: Charlie Drage <charlie@charliedrage.com> * update based on review Signed-off-by: Charlie Drage <charlie@charliedrage.com> Signed-off-by: Charlie Drage <charlie@charliedrage.com>
2022-11-07 08:14:08 +00:00
## Overview
chore: updated eap form location Signed-off-by: Dev Kumar <devskumar99@gmail.com>
2022-07-13 16:44:52 +00:00
docs: update readme / reorganize (#705) * docs: update readme / reorganize ### What does this PR do? Updates the README with the following: * Removes references to OpenShift * Updates the main screenshot * Reorganizes / rewords some parts of the README * Changes the link to download to the website instead of the GitHub release page ### Screenshot/screencast of this PR <!-- Please include a screenshot or a screencast explaining what is doing this PR --> N/A ### What issues does this PR fix or reference? <!-- Please include any related issue from Podman Desktop repository (or from another issue tracker). --> N/A ### How to test this PR? View it :) <!-- Please explain steps to reproduce --> Signed-off-by: Charlie Drage <charlie@charliedrage.com> * update based on review Signed-off-by: Charlie Drage <charlie@charliedrage.com> Signed-off-by: Charlie Drage <charlie@charliedrage.com>
2022-11-07 08:14:08 +00:00
Podman Desktop is a graphical interface that enables application developers to seamlessly work with containers and Kubernetes.
Update README.md Change-Id: I2e02695c460e36c6234e42c844520c9212cd0a8a Signed-off-by: Florent BENOIT <fbenoit@redhat.com>
2022-07-18 14:44:52 +00:00
Update README.md Signed-off-by: ayushrakesh <115995339+ayushrakesh@users.noreply.github.com>
2023-10-19 06:43:29 +00:00
Podman Desktop installs, configures, and keeps Podman up to date on your local environment. It provides a system tray, to check status and interact with your container engine without losing focus from other tasks. The desktop application provides a dashboard to interact with containers, images, pods, and volumes but also configures your environment with your OCI registries and network settings. Podman Desktop also provides capabilities to connect and deploy pods to Kubernetes environments.
chore: updated eap form location Signed-off-by: Dev Kumar <devskumar99@gmail.com>
2022-07-13 16:44:52 +00:00
chore: reword 'can be extended' Signed-off-by: Tim deBoer <git@tdeboer.ca>
2025-01-27 21:55:57 +00:00
Podman Desktop supports [multiple container engines](#multiple-container-engine-support), and extends its capabilities through [extensions](https://podman-desktop.io/extensions)!
docs: fix wording (credits to Gerard) Change-Id: I01c6f7d36ff47d658673853951697df254e6d0d8 Signed-off-by: Florent Benoit <fbenoit@redhat.com>
2022-04-13 11:46:33 +00:00
docs: update readme / reorganize (#705) * docs: update readme / reorganize ### What does this PR do? Updates the README with the following: * Removes references to OpenShift * Updates the main screenshot * Reorganizes / rewords some parts of the README * Changes the link to download to the website instead of the GitHub release page ### Screenshot/screencast of this PR <!-- Please include a screenshot or a screencast explaining what is doing this PR --> N/A ### What issues does this PR fix or reference? <!-- Please include any related issue from Podman Desktop repository (or from another issue tracker). --> N/A ### How to test this PR? View it :) <!-- Please explain steps to reproduce --> Signed-off-by: Charlie Drage <charlie@charliedrage.com> * update based on review Signed-off-by: Charlie Drage <charlie@charliedrage.com> Signed-off-by: Charlie Drage <charlie@charliedrage.com>
2022-11-07 08:14:08 +00:00
## Download
Update repo readme: overview and description (#690) * Update Readme.MD overview and description Signed-off-by: Stévan Le Meur <1636769+slemeur@users.noreply.github.com> * Refine wording Signed-off-by: Stévan Le Meur <1636769+slemeur@users.noreply.github.com> Signed-off-by: Stévan Le Meur <1636769+slemeur@users.noreply.github.com>
2022-10-25 16:23:23 +00:00
docs: update readme / reorganize (#705) * docs: update readme / reorganize ### What does this PR do? Updates the README with the following: * Removes references to OpenShift * Updates the main screenshot * Reorganizes / rewords some parts of the README * Changes the link to download to the website instead of the GitHub release page ### Screenshot/screencast of this PR <!-- Please include a screenshot or a screencast explaining what is doing this PR --> N/A ### What issues does this PR fix or reference? <!-- Please include any related issue from Podman Desktop repository (or from another issue tracker). --> N/A ### How to test this PR? View it :) <!-- Please explain steps to reproduce --> Signed-off-by: Charlie Drage <charlie@charliedrage.com> * update based on review Signed-off-by: Charlie Drage <charlie@charliedrage.com> Signed-off-by: Charlie Drage <charlie@charliedrage.com>
2022-11-07 08:14:08 +00:00
Check the downloads page on [podman-desktop.io/downloads](https://podman-desktop.io/downloads).
Update repo readme: overview and description (#690) * Update Readme.MD overview and description Signed-off-by: Stévan Le Meur <1636769+slemeur@users.noreply.github.com> * Refine wording Signed-off-by: Stévan Le Meur <1636769+slemeur@users.noreply.github.com> Signed-off-by: Stévan Le Meur <1636769+slemeur@users.noreply.github.com>
2022-10-25 16:23:23 +00:00
docs: quickfix the readme.md (#805) ### What does this PR do? * Fixes the missing section on features * Adds another entry to the TOC * Fixes spacing / newline ### Screenshot/screencast of this PR <!-- Please include a screenshot or a screencast explaining what is doing this PR --> ### What issues does this PR fix or reference? <!-- Please include any related issue from Podman Desktop repository (or from another issue tracker). --> ### How to test this PR? <!-- Please explain steps to reproduce --> Signed-off-by: Charlie Drage <charlie@charliedrage.com> Signed-off-by: Charlie Drage <charlie@charliedrage.com>
2022-11-10 13:53:25 +00:00
## Features
docs: update readme / reorganize (#705) * docs: update readme / reorganize ### What does this PR do? Updates the README with the following: * Removes references to OpenShift * Updates the main screenshot * Reorganizes / rewords some parts of the README * Changes the link to download to the website instead of the GitHub release page ### Screenshot/screencast of this PR <!-- Please include a screenshot or a screencast explaining what is doing this PR --> N/A ### What issues does this PR fix or reference? <!-- Please include any related issue from Podman Desktop repository (or from another issue tracker). --> N/A ### How to test this PR? View it :) <!-- Please explain steps to reproduce --> Signed-off-by: Charlie Drage <charlie@charliedrage.com> * update based on review Signed-off-by: Charlie Drage <charlie@charliedrage.com> Signed-off-by: Charlie Drage <charlie@charliedrage.com>
2022-11-07 08:14:08 +00:00
#### Containers and pods dashboard
chore: apply prettier on .md, .json and .css files Change-Id: Ic08ccbb1f248d07c39cdc768daa3423bfef7e6fc Signed-off-by: Florent Benoit <fbenoit@redhat.com>
2023-06-14 07:59:27 +00:00
- Build, run, manage, and debug both containers and pods
- Run Pods on your container engine or with Kubernetes
- Convert your Pods to be running on Kubernetes
- Manage multiple container engines
Update repo readme: overview and description (#690) * Update Readme.MD overview and description Signed-off-by: Stévan Le Meur <1636769+slemeur@users.noreply.github.com> * Refine wording Signed-off-by: Stévan Le Meur <1636769+slemeur@users.noreply.github.com> Signed-off-by: Stévan Le Meur <1636769+slemeur@users.noreply.github.com>
2022-10-25 16:23:23 +00:00
docs: update readme / reorganize (#705) * docs: update readme / reorganize ### What does this PR do? Updates the README with the following: * Removes references to OpenShift * Updates the main screenshot * Reorganizes / rewords some parts of the README * Changes the link to download to the website instead of the GitHub release page ### Screenshot/screencast of this PR <!-- Please include a screenshot or a screencast explaining what is doing this PR --> N/A ### What issues does this PR fix or reference? <!-- Please include any related issue from Podman Desktop repository (or from another issue tracker). --> N/A ### How to test this PR? View it :) <!-- Please explain steps to reproduce --> Signed-off-by: Charlie Drage <charlie@charliedrage.com> * update based on review Signed-off-by: Charlie Drage <charlie@charliedrage.com> Signed-off-by: Charlie Drage <charlie@charliedrage.com>
2022-11-07 08:14:08 +00:00
#### Multiple container engine support
chore: apply prettier on .md, .json and .css files Change-Id: Ic08ccbb1f248d07c39cdc768daa3423bfef7e6fc Signed-off-by: Florent Benoit <fbenoit@redhat.com>
2023-06-14 07:59:27 +00:00
- [Podman container engine](https://github.com/containers/podman)
- [crc](https://github.com/code-ready/crc)
docs: drop the word virtual from lima The linux machine can be both physical and virtual. Each is referred to as a "Lima instance" (not VM). Signed-off-by: Anders F Björklund <anders.f.bjorklund@gmail.com>
2024-02-14 17:06:53 +00:00
- [Lima: Linux Machines](https://github.com/lima-vm/lima)
docs: lima is not a container engine (#3051) * docs: lima is not a container engine You can use Lima to run different container engines, such as containerd or Docker or Podman but it runs virtual machines. Currently containerd is *only* supported through Kubernetes, there is no direct support for "nerdctl" in Podman Desktop. Signed-off-by: Anders F Björklund <anders.f.bjorklund@gmail.com> * docs: change github used for docker While it redirects to github.com/moby/moby, many places still reference the code as github.com/docker/docker. Signed-off-by: Anders F Björklund <anders.f.bjorklund@gmail.com> --------- Signed-off-by: Anders F Björklund <anders.f.bjorklund@gmail.com>
2023-06-30 19:11:20 +00:00
- [Docker container engine](https://github.com/docker/docker)
Update repo readme: overview and description (#690) * Update Readme.MD overview and description Signed-off-by: Stévan Le Meur <1636769+slemeur@users.noreply.github.com> * Refine wording Signed-off-by: Stévan Le Meur <1636769+slemeur@users.noreply.github.com> Signed-off-by: Stévan Le Meur <1636769+slemeur@users.noreply.github.com>
2022-10-25 16:23:23 +00:00
docs: update readme / reorganize (#705) * docs: update readme / reorganize ### What does this PR do? Updates the README with the following: * Removes references to OpenShift * Updates the main screenshot * Reorganizes / rewords some parts of the README * Changes the link to download to the website instead of the GitHub release page ### Screenshot/screencast of this PR <!-- Please include a screenshot or a screencast explaining what is doing this PR --> N/A ### What issues does this PR fix or reference? <!-- Please include any related issue from Podman Desktop repository (or from another issue tracker). --> N/A ### How to test this PR? View it :) <!-- Please explain steps to reproduce --> Signed-off-by: Charlie Drage <charlie@charliedrage.com> * update based on review Signed-off-by: Charlie Drage <charlie@charliedrage.com> Signed-off-by: Charlie Drage <charlie@charliedrage.com>
2022-11-07 08:14:08 +00:00
#### Podman engine update support
chore: apply prettier on .md, .json and .css files Change-Id: Ic08ccbb1f248d07c39cdc768daa3423bfef7e6fc Signed-off-by: Florent Benoit <fbenoit@redhat.com>
2023-06-14 07:59:27 +00:00
- Keep `podman` up-to-date on your PC by having Podman Desktop automatically install the newest version
docs: fix wording (credits to Gerard) Change-Id: I01c6f7d36ff47d658673853951697df254e6d0d8 Signed-off-by: Florent Benoit <fbenoit@redhat.com>
2022-04-13 11:46:33 +00:00
docs: update readme / reorganize (#705) * docs: update readme / reorganize ### What does this PR do? Updates the README with the following: * Removes references to OpenShift * Updates the main screenshot * Reorganizes / rewords some parts of the README * Changes the link to download to the website instead of the GitHub release page ### Screenshot/screencast of this PR <!-- Please include a screenshot or a screencast explaining what is doing this PR --> N/A ### What issues does this PR fix or reference? <!-- Please include any related issue from Podman Desktop repository (or from another issue tracker). --> N/A ### How to test this PR? View it :) <!-- Please explain steps to reproduce --> Signed-off-by: Charlie Drage <charlie@charliedrage.com> * update based on review Signed-off-by: Charlie Drage <charlie@charliedrage.com> Signed-off-by: Charlie Drage <charlie@charliedrage.com>
2022-11-07 08:14:08 +00:00
#### System tray support
chore: apply prettier on .md, .json and .css files Change-Id: Ic08ccbb1f248d07c39cdc768daa3423bfef7e6fc Signed-off-by: Florent Benoit <fbenoit@redhat.com>
2023-06-14 07:59:27 +00:00
- Manage your Container engine
- Define your Kubernetes context
docs: fix wording (credits to Gerard) Change-Id: I01c6f7d36ff47d658673853951697df254e6d0d8 Signed-off-by: Florent Benoit <fbenoit@redhat.com>
2022-04-13 11:46:33 +00:00
docs: update readme / reorganize (#705) * docs: update readme / reorganize ### What does this PR do? Updates the README with the following: * Removes references to OpenShift * Updates the main screenshot * Reorganizes / rewords some parts of the README * Changes the link to download to the website instead of the GitHub release page ### Screenshot/screencast of this PR <!-- Please include a screenshot or a screencast explaining what is doing this PR --> N/A ### What issues does this PR fix or reference? <!-- Please include any related issue from Podman Desktop repository (or from another issue tracker). --> N/A ### How to test this PR? View it :) <!-- Please explain steps to reproduce --> Signed-off-by: Charlie Drage <charlie@charliedrage.com> * update based on review Signed-off-by: Charlie Drage <charlie@charliedrage.com> Signed-off-by: Charlie Drage <charlie@charliedrage.com>
2022-11-07 08:14:08 +00:00
#### Enterprise capabilities
chore: apply prettier on .md, .json and .css files Change-Id: Ic08ccbb1f248d07c39cdc768daa3423bfef7e6fc Signed-off-by: Florent Benoit <fbenoit@redhat.com>
2023-06-14 07:59:27 +00:00
- Proxy Support
- OCI Image registries management
docs: fix wording (credits to Gerard) Change-Id: I01c6f7d36ff47d658673853951697df254e6d0d8 Signed-off-by: Florent Benoit <fbenoit@redhat.com>
2022-04-13 11:46:33 +00:00
docs: update readme / reorganize (#705) * docs: update readme / reorganize ### What does this PR do? Updates the README with the following: * Removes references to OpenShift * Updates the main screenshot * Reorganizes / rewords some parts of the README * Changes the link to download to the website instead of the GitHub release page ### Screenshot/screencast of this PR <!-- Please include a screenshot or a screencast explaining what is doing this PR --> N/A ### What issues does this PR fix or reference? <!-- Please include any related issue from Podman Desktop repository (or from another issue tracker). --> N/A ### How to test this PR? View it :) <!-- Please explain steps to reproduce --> Signed-off-by: Charlie Drage <charlie@charliedrage.com> * update based on review Signed-off-by: Charlie Drage <charlie@charliedrage.com> Signed-off-by: Charlie Drage <charlie@charliedrage.com>
2022-11-07 08:14:08 +00:00
#### Bridge between local and remote environments
chore: apply prettier on .md, .json and .css files Change-Id: Ic08ccbb1f248d07c39cdc768daa3423bfef7e6fc Signed-off-by: Florent Benoit <fbenoit@redhat.com>
2023-06-14 07:59:27 +00:00
- Connect and deploy to both local or remote Kubernetes environments
- Change your Kubernetes context and pick your deployment environment
docs: fix wording (credits to Gerard) Change-Id: I01c6f7d36ff47d658673853951697df254e6d0d8 Signed-off-by: Florent Benoit <fbenoit@redhat.com>
2022-04-13 11:46:33 +00:00
docs: update readme / reorganize (#705) * docs: update readme / reorganize ### What does this PR do? Updates the README with the following: * Removes references to OpenShift * Updates the main screenshot * Reorganizes / rewords some parts of the README * Changes the link to download to the website instead of the GitHub release page ### Screenshot/screencast of this PR <!-- Please include a screenshot or a screencast explaining what is doing this PR --> N/A ### What issues does this PR fix or reference? <!-- Please include any related issue from Podman Desktop repository (or from another issue tracker). --> N/A ### How to test this PR? View it :) <!-- Please explain steps to reproduce --> Signed-off-by: Charlie Drage <charlie@charliedrage.com> * update based on review Signed-off-by: Charlie Drage <charlie@charliedrage.com> Signed-off-by: Charlie Drage <charlie@charliedrage.com>
2022-11-07 08:14:08 +00:00
## Join our early adopter program! (optional)
We are seeking developers who are interested in improving Podman Desktop!
Register your interest to join our Early Adopter Program by filling <a href="https://forms.gle/ow73dV7Ce3YLzoXH7" target="_blank">this form</a>.
chore: apply prettier on .md, .json and .css files Change-Id: Ic08ccbb1f248d07c39cdc768daa3423bfef7e6fc Signed-off-by: Florent Benoit <fbenoit@redhat.com>
2023-06-14 07:59:27 +00:00
This is totally _optional_ and does not change any Podman Desktop features.
docs: fix wording (credits to Gerard) Change-Id: I01c6f7d36ff47d658673853951697df254e6d0d8 Signed-off-by: Florent Benoit <fbenoit@redhat.com>
2022-04-13 11:46:33 +00:00
## Roadmap
docs: update readme / reorganize (#705) * docs: update readme / reorganize ### What does this PR do? Updates the README with the following: * Removes references to OpenShift * Updates the main screenshot * Reorganizes / rewords some parts of the README * Changes the link to download to the website instead of the GitHub release page ### Screenshot/screencast of this PR <!-- Please include a screenshot or a screencast explaining what is doing this PR --> N/A ### What issues does this PR fix or reference? <!-- Please include any related issue from Podman Desktop repository (or from another issue tracker). --> N/A ### How to test this PR? View it :) <!-- Please explain steps to reproduce --> Signed-off-by: Charlie Drage <charlie@charliedrage.com> * update based on review Signed-off-by: Charlie Drage <charlie@charliedrage.com> Signed-off-by: Charlie Drage <charlie@charliedrage.com>
2022-11-07 08:14:08 +00:00
All upcoming features are tracked with GitHub milestones.
Check out all our [future features!](https://github.com/containers/podman-desktop/milestones)
docs: fix wording (credits to Gerard) Change-Id: I01c6f7d36ff47d658673853951697df254e6d0d8 Signed-off-by: Florent Benoit <fbenoit@redhat.com>
2022-04-13 11:46:33 +00:00
## Contributing
docs: update readme / reorganize (#705) * docs: update readme / reorganize ### What does this PR do? Updates the README with the following: * Removes references to OpenShift * Updates the main screenshot * Reorganizes / rewords some parts of the README * Changes the link to download to the website instead of the GitHub release page ### Screenshot/screencast of this PR <!-- Please include a screenshot or a screencast explaining what is doing this PR --> N/A ### What issues does this PR fix or reference? <!-- Please include any related issue from Podman Desktop repository (or from another issue tracker). --> N/A ### How to test this PR? View it :) <!-- Please explain steps to reproduce --> Signed-off-by: Charlie Drage <charlie@charliedrage.com> * update based on review Signed-off-by: Charlie Drage <charlie@charliedrage.com> Signed-off-by: Charlie Drage <charlie@charliedrage.com>
2022-11-07 08:14:08 +00:00
Interested in fixing issues or contributing to Podman Desktop?
chore: apply prettier on .md, .json and .css files Change-Id: Ic08ccbb1f248d07c39cdc768daa3423bfef7e6fc Signed-off-by: Florent Benoit <fbenoit@redhat.com>
2023-06-14 07:59:27 +00:00
docs: update readme / reorganize (#705) * docs: update readme / reorganize ### What does this PR do? Updates the README with the following: * Removes references to OpenShift * Updates the main screenshot * Reorganizes / rewords some parts of the README * Changes the link to download to the website instead of the GitHub release page ### Screenshot/screencast of this PR <!-- Please include a screenshot or a screencast explaining what is doing this PR --> N/A ### What issues does this PR fix or reference? <!-- Please include any related issue from Podman Desktop repository (or from another issue tracker). --> N/A ### How to test this PR? View it :) <!-- Please explain steps to reproduce --> Signed-off-by: Charlie Drage <charlie@charliedrage.com> * update based on review Signed-off-by: Charlie Drage <charlie@charliedrage.com> Signed-off-by: Charlie Drage <charlie@charliedrage.com>
2022-11-07 08:14:08 +00:00
- :bug: [File bugs or feature requests on GitHub](https://github.com/containers/podman-desktop/issues/new/choose)
- :checkered_flag: [Read our contributing guide](./CONTRIBUTING.md)
- :ok_hand: [Review or contribute a pull request](https://github.com/containers/podman-desktop/pulls)
docs: fix wording (credits to Gerard) Change-Id: I01c6f7d36ff47d658673853951697df254e6d0d8 Signed-off-by: Florent Benoit <fbenoit@redhat.com>
2022-04-13 11:46:33 +00:00
## Communication
docs: update readme / reorganize (#705) * docs: update readme / reorganize ### What does this PR do? Updates the README with the following: * Removes references to OpenShift * Updates the main screenshot * Reorganizes / rewords some parts of the README * Changes the link to download to the website instead of the GitHub release page ### Screenshot/screencast of this PR <!-- Please include a screenshot or a screencast explaining what is doing this PR --> N/A ### What issues does this PR fix or reference? <!-- Please include any related issue from Podman Desktop repository (or from another issue tracker). --> N/A ### How to test this PR? View it :) <!-- Please explain steps to reproduce --> Signed-off-by: Charlie Drage <charlie@charliedrage.com> * update based on review Signed-off-by: Charlie Drage <charlie@charliedrage.com> Signed-off-by: Charlie Drage <charlie@charliedrage.com>
2022-11-07 08:14:08 +00:00
For all bug and feature requests please [file a GitHub issue](https://github.com/containers/podman-desktop/issues/new/choose).
docs: fix wording (credits to Gerard) Change-Id: I01c6f7d36ff47d658673853951697df254e6d0d8 Signed-off-by: Florent Benoit <fbenoit@redhat.com>
2022-04-13 11:46:33 +00:00
Update README.md Github -> GitHub Signed-off-by: Ikko Eltociear Ashimine <eltociear@gmail.com>
2023-10-03 16:27:01 +00:00
Discussions are done using [GitHub Discussions](https://github.com/containers/podman-desktop/discussions/).
docs: fix wording (credits to Gerard) Change-Id: I01c6f7d36ff47d658673853951697df254e6d0d8 Signed-off-by: Florent Benoit <fbenoit@redhat.com>
2022-04-13 11:46:33 +00:00
docs: update readme and site on new chat channels (#846) ### What does this PR do? Updates the readme.md as well as site for matrix & irc ### Screenshot/screencast of this PR N/A ### What issues does this PR fix or reference? <!-- Please include any related issue from Podman Desktop repository (or from another issue tracker). --> Fixes https://github.com/containers/podman-desktop/issues/842 ### How to test this PR? <!-- Please explain steps to reproduce --> View the README.md or website :) Signed-off-by: Charlie Drage <charlie@charliedrage.com> Signed-off-by: Charlie Drage <charlie@charliedrage.com>
2022-11-17 14:08:15 +00:00
### Chatting
docs: add k8s slack channel (#792) * docs: add k8s slack channel ### What does this PR do? Adds the Kubernetes slack channel to the site / README as well as Podman Desktop help page ### Screenshot/screencast of this PR <!-- Please include a screenshot or a screencast explaining what is doing this PR --> N/A ### What issues does this PR fix or reference? <!-- Please include any related issue from Podman Desktop repository (or from another issue tracker). --> N/A ### How to test this PR? N/A <!-- Please explain steps to reproduce --> Signed-off-by: Charlie Drage <charlie@charliedrage.com> * update link Signed-off-by: Charlie Drage <charlie@charliedrage.com> Signed-off-by: Charlie Drage <charlie@charliedrage.com>
2022-11-10 12:55:09 +00:00
docs: update readme and site on new chat channels (#846) ### What does this PR do? Updates the readme.md as well as site for matrix & irc ### Screenshot/screencast of this PR N/A ### What issues does this PR fix or reference? <!-- Please include any related issue from Podman Desktop repository (or from another issue tracker). --> Fixes https://github.com/containers/podman-desktop/issues/842 ### How to test this PR? <!-- Please explain steps to reproduce --> View the README.md or website :) Signed-off-by: Charlie Drage <charlie@charliedrage.com> Signed-off-by: Charlie Drage <charlie@charliedrage.com>
2022-11-17 14:08:15 +00:00
General questions & development:
chore: apply prettier on .md, .json and .css files Change-Id: Ic08ccbb1f248d07c39cdc768daa3423bfef7e6fc Signed-off-by: Florent Benoit <fbenoit@redhat.com>
2023-06-14 07:59:27 +00:00
- [#podman-desktop on the Podman Discord](https://discord.com/invite/x5GzFF6QH4)
- [#podman-desktop@libera.chat on IRC](https://libera.chat/)
- [#podman-desktop@fedora.im on Matrix](https://chat.fedoraproject.org/#/room/#podman-desktop:fedora.im)
docs: update readme and site on new chat channels (#846) ### What does this PR do? Updates the readme.md as well as site for matrix & irc ### Screenshot/screencast of this PR N/A ### What issues does this PR fix or reference? <!-- Please include any related issue from Podman Desktop repository (or from another issue tracker). --> Fixes https://github.com/containers/podman-desktop/issues/842 ### How to test this PR? <!-- Please explain steps to reproduce --> View the README.md or website :) Signed-off-by: Charlie Drage <charlie@charliedrage.com> Signed-off-by: Charlie Drage <charlie@charliedrage.com>
2022-11-17 14:08:15 +00:00
fix typos in README.md (#4240) * Update README.md I found a few typos and improvements in README.md 1. In the "Download" section, consider capitalizing the first letter for consistency: "Check the Downloads page on podman-desktop.io/downloads." 2. In the "Contributing" section, consider making the section titles more consistent by capitalizing the first letter: ":bug: File Bugs or Feature Requests on GitHub" and ":checkered_flag: Read Our Contributing Guide". 3. In the "Communication" section, you might want to clarify the phrasing: "All channels are bridged. Chat on either Discord, IRC, or Matrix, and it will appear on all three!" "Join our early adopter program! (optional)" section, you can make the phrase "optional" more visually distinct, like this: "This is entirely optional and does not impact any Podman Desktop features." Signed-off-by: Rahul Kumar <104289350+rahul0x00@users.noreply.github.com> * Update README.md The headings now follow the sentence-style capitalization as per your preference. Signed-off-by: Rahul Kumar <104289350+rahul0x00@users.noreply.github.com> * Update README.md Signed-off-by: Rahul Kumar <104289350+rahul0x00@users.noreply.github.com> --------- Signed-off-by: Rahul Kumar <104289350+rahul0x00@users.noreply.github.com>
2023-10-11 08:41:08 +00:00
Note: All channels are bridged. Chat on either Discord, IRC, or Matrix, and your messages will appear on all three platforms!
docs: update readme and site on new chat channels (#846) ### What does this PR do? Updates the readme.md as well as site for matrix & irc ### Screenshot/screencast of this PR N/A ### What issues does this PR fix or reference? <!-- Please include any related issue from Podman Desktop repository (or from another issue tracker). --> Fixes https://github.com/containers/podman-desktop/issues/842 ### How to test this PR? <!-- Please explain steps to reproduce --> View the README.md or website :) Signed-off-by: Charlie Drage <charlie@charliedrage.com> Signed-off-by: Charlie Drage <charlie@charliedrage.com>
2022-11-17 14:08:15 +00:00
Kubernetes questions & development:
chore: apply prettier on .md, .json and .css files Change-Id: Ic08ccbb1f248d07c39cdc768daa3423bfef7e6fc Signed-off-by: Florent Benoit <fbenoit@redhat.com>
2023-06-14 07:59:27 +00:00
- [#podman-desktop](https://app.slack.com/client/T09NY5SBT/C04A0L7LUFM) on the [Kubernetes Slack](https://slack.k8s.io/)
docs: add k8s slack channel (#792) * docs: add k8s slack channel ### What does this PR do? Adds the Kubernetes slack channel to the site / README as well as Podman Desktop help page ### Screenshot/screencast of this PR <!-- Please include a screenshot or a screencast explaining what is doing this PR --> N/A ### What issues does this PR fix or reference? <!-- Please include any related issue from Podman Desktop repository (or from another issue tracker). --> N/A ### How to test this PR? N/A <!-- Please explain steps to reproduce --> Signed-off-by: Charlie Drage <charlie@charliedrage.com> * update link Signed-off-by: Charlie Drage <charlie@charliedrage.com> Signed-off-by: Charlie Drage <charlie@charliedrage.com>
2022-11-10 12:55:09 +00:00
Add an ADOPTERS.md file to the project (#3461) * Create ADOPTERS.md Add initial adopters.md file to the root directory of the repo Signed-off-by: Stévan Le Meur <1636769+slemeur@users.noreply.github.com> * Update ADOPTERS.md Improve the description for the sample Signed-off-by: Stévan Le Meur <1636769+slemeur@users.noreply.github.com> * Update README.md Add a reference to adopters.md in readme.md Signed-off-by: Stévan Le Meur <1636769+slemeur@users.noreply.github.com> --------- Signed-off-by: Stévan Le Meur <1636769+slemeur@users.noreply.github.com>
2023-08-17 13:05:17 +00:00
### Adopters
Fix link to the adopter file in README.md (#3873) * Update README.md Fix link to the adopter file Signed-off-by: Stévan Le Meur <1636769+slemeur@users.noreply.github.com>
2023-09-12 14:19:26 +00:00
Check out the [list of companies](./ADOPTERS.md) already using Podman Desktop.
Add an ADOPTERS.md file to the project (#3461) * Create ADOPTERS.md Add initial adopters.md file to the root directory of the repo Signed-off-by: Stévan Le Meur <1636769+slemeur@users.noreply.github.com> * Update ADOPTERS.md Improve the description for the sample Signed-off-by: Stévan Le Meur <1636769+slemeur@users.noreply.github.com> * Update README.md Add a reference to adopters.md in readme.md Signed-off-by: Stévan Le Meur <1636769+slemeur@users.noreply.github.com> --------- Signed-off-by: Stévan Le Meur <1636769+slemeur@users.noreply.github.com>
2023-08-17 13:05:17 +00:00
docs: fix wording (credits to Gerard) Change-Id: I01c6f7d36ff47d658673853951697df254e6d0d8 Signed-off-by: Florent Benoit <fbenoit@redhat.com>
2022-04-13 11:46:33 +00:00
## Code of Conduct
docs: update readme / reorganize (#705) * docs: update readme / reorganize ### What does this PR do? Updates the README with the following: * Removes references to OpenShift * Updates the main screenshot * Reorganizes / rewords some parts of the README * Changes the link to download to the website instead of the GitHub release page ### Screenshot/screencast of this PR <!-- Please include a screenshot or a screencast explaining what is doing this PR --> N/A ### What issues does this PR fix or reference? <!-- Please include any related issue from Podman Desktop repository (or from another issue tracker). --> N/A ### How to test this PR? View it :) <!-- Please explain steps to reproduce --> Signed-off-by: Charlie Drage <charlie@charliedrage.com> * update based on review Signed-off-by: Charlie Drage <charlie@charliedrage.com> Signed-off-by: Charlie Drage <charlie@charliedrage.com>
2022-11-07 08:14:08 +00:00
This project uses the [Containers Community Code of Conduct](https://github.com/containers/common/blob/main/CODE-OF-CONDUCT.md).
docs: fix wording (credits to Gerard) Change-Id: I01c6f7d36ff47d658673853951697df254e6d0d8 Signed-off-by: Florent Benoit <fbenoit@redhat.com>
2022-04-13 11:46:33 +00:00
chore: include argos-ci badge for OSS Sponsorship related to https://github.com/containers/podman-desktop/pull/4721 Signed-off-by: Florent Benoit <fbenoit@redhat.com>
2023-11-08 21:44:06 +00:00
## Testing
Use large badge for Argos Signed-off-by: Greg Bergé <berge.greg@gmail.com>
2023-11-09 10:46:57 +00:00
[![Covered by Argos Visual Testing](https://argos-ci.com/badge-large.svg)](https://app.argos-ci.com/containers/podman-desktop/reference)
chore: include argos-ci badge for OSS Sponsorship related to https://github.com/containers/podman-desktop/pull/4721 Signed-off-by: Florent Benoit <fbenoit@redhat.com>
2023-11-08 21:44:06 +00:00
docs: fix wording (credits to Gerard) Change-Id: I01c6f7d36ff47d658673853951697df254e6d0d8 Signed-off-by: Florent Benoit <fbenoit@redhat.com>
2022-04-13 11:46:33 +00:00
## License
chore: updated link to the Matrix room (#1076) chore: updated link https://chat.fedoraproject.org/#/room/#podman-desktop:fedora.im Signed-off-by: Fabrice Flore-Thébault <ffloreth@redhat.com> Signed-off-by: Fabrice Flore-Thébault <ffloreth@redhat.com>
2022-12-21 14:18:35 +00:00
Licensed under [Apache 2.0](LICENSE).
Reference in a new issue Copy permalink