├── .github ├── FUNDING.yml ├── ISSUE_TEMPLATE │ ├── bug_report.md │ └── feature_request.md ├── dependabot.yml ├── pull_request_template.md └── workflows │ ├── docs-readme-scribe.yml │ └── lint-pr.yml ├── CODE_OF_CONDUCT.md ├── CONTRIBUTING.md ├── README.md ├── SECURITY.md ├── profile └── README.md └── templates └── README.md.tpl /.github/FUNDING.yml: -------------------------------------------------------------------------------- 1 | # These are supported funding model platforms 2 | 3 | github: [flexiondotorg, ymauray, marxjohnson, popey] 4 | patreon: # Replace with a single Patreon username 5 | open_collective: # Replace with a single Open Collective username 6 | ko_fi: # Replace with a single Ko-fi username 7 | tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel 8 | community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry 9 | liberapay: # Replace with a single Liberapay username 10 | issuehunt: # Replace with a single IssueHunt username 11 | lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry 12 | polar: # Replace with a single Polar username 13 | buy_me_a_coffee: # Replace with a single Buy Me a Coffee username 14 | custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2'] 15 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/bug_report.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Bug report 3 | about: Create a report to help us improve 4 | title: 'bug: description of the bug you encountered' 5 | labels: '' 6 | assignees: '' 7 | 8 | --- 9 | 10 | **I confirm this bug has not already been reported** 11 | - [ ] I have searched the issues and this bug has not been reported previously 12 | 13 | **Describe the bug** 14 | A clear and concise description of what the bug is. 15 | 16 | **To Reproduce** 17 | Steps to reproduce the behavior: 18 | 1. Do a thing 19 | 2. See error 20 | 21 | **Expected behavior** 22 | A clear and concise description of what you expected to happen. 23 | 24 | **Screenshots** 25 | If applicable, add screenshots to help explain your problem. 26 | 27 | **Additional context** 28 | Add any other context about the problem here. 29 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/feature_request.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Feature request 3 | about: Suggest an idea for this project 4 | title: 'feat: describe the feature you are requesting' 5 | labels: '' 6 | assignees: '' 7 | 8 | --- 9 | 10 | **I confirm this feature has not been previously requested** 11 | - [ ] I have searched the issues and this feature has not previously been requested 12 | 13 | **Is your feature request related to a problem? Please describe.** 14 | A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] 15 | 16 | **Describe the solution you'd like** 17 | A clear and concise description of what you want to happen. 18 | 19 | **Describe alternatives you've considered** 20 | A clear and concise description of any alternative solutions or features you've considered. 21 | 22 | **Additional context** 23 | Add any other context or screenshots about the feature request here. 24 | -------------------------------------------------------------------------------- /.github/dependabot.yml: -------------------------------------------------------------------------------- 1 | version: 2 2 | updates: 3 | - package-ecosystem: "github-actions" 4 | directory: "/" 5 | schedule: 6 | # Check for updates to GitHub Actions every week 7 | interval: "weekly" -------------------------------------------------------------------------------- /.github/pull_request_template.md: -------------------------------------------------------------------------------- 1 | # Description 2 | 3 | Please include a summary of the changes along with any relevant motivation and context. 4 | 5 | 6 | 7 | - Closes # 8 | - Fixes # 9 | - Resolves # 10 | 11 | ## Type of change 12 | 13 | 14 | 15 | - [ ] Bug fix (non-breaking change which fixes an issue) 16 | - [ ] New feature (non-breaking change which adds functionality) 17 | - [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) 18 | - [ ] Packaging (updates the packaging) 19 | - [ ] Documentation (updates the documentation) 20 | 21 | # Checklist: 22 | 23 | 24 | 25 | - [ ] I have performed a self-review of my code 26 | - [ ] I have tested my code in common scenarios and confirmed there are no regressions 27 | - [ ] I have added comments to my code, particularly in hard-to-understand sections 28 | - [ ] I have made corresponding changes to the documentation 29 | -------------------------------------------------------------------------------- /.github/workflows/docs-readme-scribe.yml: -------------------------------------------------------------------------------- 1 | name: Update README ✍️ 2 | 3 | # Run hourly 4 | on: 5 | push: 6 | branches: [main] 7 | schedule: 8 | - cron: "0 */1 * * *" 9 | workflow_dispatch: 10 | 11 | jobs: 12 | readme-scribe: 13 | runs-on: ubuntu-22.04 14 | steps: 15 | - uses: actions/checkout@v4 16 | - name: Generate README.md 17 | uses: muesli/readme-scribe@v0.1 18 | with: 19 | template: "templates/README.md.tpl" 20 | writeTo: "README.md" 21 | - name: Commit README.md 22 | uses: stefanzweifel/git-auto-commit-action@v5 23 | env: 24 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} 25 | with: 26 | commit_message: "docs: update README.md" 27 | branch: main 28 | commit_user_name: GitHub Actions 29 | commit_user_email: actions@github.com 30 | commit_author: GitHub Actions 31 | -------------------------------------------------------------------------------- /.github/workflows/lint-pr.yml: -------------------------------------------------------------------------------- 1 | name: "Lint Pull Request 🐙" 2 | 3 | on: 4 | pull_request_target: 5 | types: 6 | - opened 7 | - edited 8 | - synchronize 9 | 10 | permissions: 11 | pull-requests: read 12 | 13 | jobs: 14 | main: 15 | name: Validate pull request title 16 | runs-on: ubuntu-22.04 17 | steps: 18 | - uses: amannn/action-semantic-pull-request@v5 19 | env: 20 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} 21 | with: 22 | # If the PR only contains a single commit, the action will validate that 23 | # it matches the configured pattern. 24 | validateSingleCommit: true 25 | # Related to `validateSingleCommit` you can opt-in to validate that the PR 26 | # title matches a single commit to avoid confusion. 27 | validateSingleCommitMatchesPrTitle: true 28 | -------------------------------------------------------------------------------- /CODE_OF_CONDUCT.md: -------------------------------------------------------------------------------- 1 | # Contributor Covenant Code of Conduct 2 | 3 | ## Our Pledge 4 | 5 | We as members, contributors, and leaders pledge to make participation in our 6 | community a harassment-free experience for everyone, regardless of age, body 7 | size, visible or invisible disability, ethnicity, sex characteristics, gender 8 | identity and expression, level of experience, education, socio-economic status, 9 | nationality, personal appearance, race, religion, or sexual identity 10 | and orientation. 11 | 12 | We pledge to act and interact in ways that contribute to an open, welcoming, 13 | diverse, inclusive, and healthy community. 14 | 15 | ## Our Standards 16 | 17 | Examples of behavior that contributes to a positive environment for our 18 | community include: 19 | 20 | * Demonstrating empathy and kindness toward other people 21 | * Being respectful of differing opinions, viewpoints, and experiences 22 | * Giving and gracefully accepting constructive feedback 23 | * Accepting responsibility and apologizing to those affected by our mistakes, 24 | and learning from the experience 25 | * Focusing on what is best not just for us as individuals, but for the 26 | overall community 27 | 28 | Examples of unacceptable behavior include: 29 | 30 | * The use of sexualized language or imagery, and sexual attention or 31 | advances of any kind 32 | * Trolling, insulting or derogatory comments, and personal or political attacks 33 | * Public or private harassment 34 | * Publishing others' private information, such as a physical or email 35 | address, without their explicit permission 36 | * Other conduct which could reasonably be considered inappropriate in a 37 | professional setting 38 | 39 | ## Enforcement Responsibilities 40 | 41 | Community leaders are responsible for clarifying and enforcing our standards of 42 | acceptable behavior and will take appropriate and fair corrective action in 43 | response to any behavior that they deem inappropriate, threatening, offensive, 44 | or harmful. 45 | 46 | Community leaders have the right and responsibility to remove, edit, or reject 47 | comments, commits, code, wiki edits, issues, and other contributions that are 48 | not aligned to this Code of Conduct, and will communicate reasons for moderation 49 | decisions when appropriate. 50 | 51 | ## Scope 52 | 53 | This Code of Conduct applies within all community spaces, and also applies when 54 | an individual is officially representing the community in public spaces. 55 | Examples of representing our community include using an official e-mail address, 56 | posting via an official social media account, or acting as an appointed 57 | representative at an online or offline event. 58 | 59 | ## Enforcement 60 | 61 | Instances of abusive, harassing, or otherwise unacceptable behavior may be 62 | reported to the community leaders responsible for enforcement at 63 | #quickemu channel on Discord. 64 | All complaints will be reviewed and investigated promptly and fairly. 65 | 66 | All community leaders are obligated to respect the privacy and security of the 67 | reporter of any incident. 68 | 69 | ## Enforcement Guidelines 70 | 71 | Community leaders will follow these Community Impact Guidelines in determining 72 | the consequences for any action they deem in violation of this Code of Conduct: 73 | 74 | ### 1. Correction 75 | 76 | **Community Impact**: Use of inappropriate language or other behavior deemed 77 | unprofessional or unwelcome in the community. 78 | 79 | **Consequence**: A private, written warning from community leaders, providing 80 | clarity around the nature of the violation and an explanation of why the 81 | behavior was inappropriate. A public apology may be requested. 82 | 83 | ### 2. Warning 84 | 85 | **Community Impact**: A violation through a single incident or series 86 | of actions. 87 | 88 | **Consequence**: A warning with consequences for continued behavior. No 89 | interaction with the people involved, including unsolicited interaction with 90 | those enforcing the Code of Conduct, for a specified period of time. This 91 | includes avoiding interactions in community spaces as well as external channels 92 | like social media. Violating these terms may lead to a temporary or 93 | permanent ban. 94 | 95 | ### 3. Temporary Ban 96 | 97 | **Community Impact**: A serious violation of community standards, including 98 | sustained inappropriate behavior. 99 | 100 | **Consequence**: A temporary ban from any sort of interaction or public 101 | communication with the community for a specified period of time. No public or 102 | private interaction with the people involved, including unsolicited interaction 103 | with those enforcing the Code of Conduct, is allowed during this period. 104 | Violating these terms may lead to a permanent ban. 105 | 106 | ### 4. Permanent Ban 107 | 108 | **Community Impact**: Demonstrating a pattern of violation of community 109 | standards, including sustained inappropriate behavior, harassment of an 110 | individual, or aggression toward or disparagement of classes of individuals. 111 | 112 | **Consequence**: A permanent ban from any sort of public interaction within 113 | the community. 114 | 115 | ## Attribution 116 | 117 | This Code of Conduct is adapted from the [Contributor Covenant][homepage], 118 | version 2.0, available at 119 | https://www.contributor-covenant.org/version/2/0/code_of_conduct.html. 120 | 121 | Community Impact Guidelines were inspired by [Mozilla's code of conduct 122 | enforcement ladder](https://github.com/mozilla/diversity). 123 | 124 | [homepage]: https://www.contributor-covenant.org 125 | 126 | For answers to common questions about this code of conduct, see the FAQ at 127 | https://www.contributor-covenant.org/faq. Translations are available at 128 | https://www.contributor-covenant.org/translations. 129 | -------------------------------------------------------------------------------- /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | # Contributing 2 | 3 | We welcome contributions to the project. 4 | 5 | - Improve the project via [Pull requests](https://github.com/quickemu-project/.github/pulls) to add new content ✨ or fix bugs 🐞 6 | - Commit messages must [conform to the Conventional Commits specification](https://www.conventionalcommits.org/) 7 | - [File issues](https://github.com/quickemu-project/.github/issues) to request features or report bugs 📁 8 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 |

2 | 3 |

4 |

5 |  Discord  6 |  Mastodon  7 |  Twitter  8 |  LinkedIn  9 |

10 | 11 | **As featured on [Linux Matters](https://linuxmatters.sh) podcast!** 🐧🎙️ The presenters of Linux Matters are the creators of each of the principle Quickemu projects. We discussed Quickemu's 2024 reboot in [Episode 30 - Quickemu Rising From the Bashes](https://linuxmatters.sh/30) and in [Episode 32 - Quick, quicker, quickest](https://linuxmatters.sh/32): 12 | - [Martin](https://github.com/flexiondotorg) unveils macOS host support for [**Quickemu**](https://github.com/quickemu-project/quickemu) 13 | - [Mark](https://github.com/marxjohnson) explains the origins of the [**Quickgui**](https://github.com/quickemu-project/quickgui) desktop app and upcoming improvements 14 | - [Alan](https://github.com/popey) debuts [**Quicktest**](https://github.com/quickemu-project/quicktest); a framework for automatically testing operating systems via Quickemu 15 | 16 |
17 | Linux Matters Podcast 18 |
19 | Linux Matters Podcast 20 |
21 | 22 | ## Welcome 👋 23 | 24 | Welcome to the Quickemu Project where we make it easy to quickly create and run optimised Windows, macOS and Linux virtual machines. 25 | 26 | - [**Quickemu**](https://github.com/quickemu-project/quickemu): Quickly create and run optimised Windows, macOS and Linux virtual machines from the terminal on Linux and macOS 27 | - [**Quickgui**](https://github.com/quickemu-project/quickgui): An elegant Quickemu desktop frontend app for Linux and macOS created with Flutter. 28 | 29 | If you're involved in a Linux distro community, you might be **interested in some fast automated testing for Linux distros**. For that we have Quicktest: 30 | 31 | - [**Quicktest**](https://github.com/quickemu-project/quicktest): Quickly and automatically test systems inside Quickemu virtual machines 32 | 33 | Other projects here include: 34 | 35 | - [**Quickemu-icons**](https://github.com/quickemu-project/quickemu-icons): Icons for the Quickemu project. 36 | -------------------------------------------------------------------------------- /SECURITY.md: -------------------------------------------------------------------------------- 1 | # Security Policy 2 | 3 | ## Reporting a Vulnerability 4 | 5 | If you discover a vulnerability in the project then [file an issue](https://github.com/quickemu-project/.github/issues/new) and click *Report a vulnerability*. 6 | 7 | - This project a spare-time hobby project. 8 | - We do not have SLAs for responding to security issues. 9 | - It is a best-efforts basis. 10 | -------------------------------------------------------------------------------- /profile/README.md: -------------------------------------------------------------------------------- 1 | ../README.md -------------------------------------------------------------------------------- /templates/README.md.tpl: -------------------------------------------------------------------------------- 1 |

2 | 3 |

4 |

5 |  Discord  6 |  Mastodon  7 |  Twitter  8 |  LinkedIn  9 |

10 | 11 | **As featured on [Linux Matters](https://linuxmatters.sh) podcast!** 🐧🎙️ The presenters of Linux Matters are the creators of each of the principle Quickemu projects. We discussed Quickemu's 2024 reboot in [Episode 30 - Quickemu Rising From the Bashes](https://linuxmatters.sh/30) and in [Episode 32 - Quick, quicker, quickest](https://linuxmatters.sh/32): 12 | - [Martin](https://github.com/flexiondotorg) unveils macOS host support for [**Quickemu**](https://github.com/quickemu-project/quickemu) 13 | - [Mark](https://github.com/marxjohnson) explains the origins of the [**Quickgui**](https://github.com/quickemu-project/quickgui) desktop app and upcoming improvements 14 | - [Alan](https://github.com/popey) debuts [**Quicktest**](https://github.com/quickemu-project/quicktest); a framework for automatically testing operating systems via Quickemu 15 | 16 |
17 | Linux Matters Podcast 18 |
19 | Linux Matters Podcast 20 |
21 | 22 | ## Welcome 👋 23 | 24 | Welcome to the Quickemu Project where we make it easy to quickly create and run optimised Windows, macOS and Linux virtual machines. 25 | 26 | - [**Quickemu**](https://github.com/quickemu-project/quickemu): Quickly create and run optimised Windows, macOS and Linux virtual machines from the terminal on Linux and macOS 27 | - [**Quickgui**](https://github.com/quickemu-project/quickgui): An elegant Quickemu desktop frontend app for Linux and macOS created with Flutter. 28 | 29 | If you're involved in a Linux distro community, you might be **interested in some fast automated testing for Linux distros**. For that we have Quicktest: 30 | 31 | - [**Quicktest**](https://github.com/quickemu-project/quicktest): Quickly and automatically test systems inside Quickemu virtual machines 32 | 33 | Other projects here include: 34 | 35 | - [**Quickemu-icons**](https://github.com/quickemu-project/quickemu-icons): Icons for the Quickemu project. 36 | --------------------------------------------------------------------------------