Skip to content

Add a developer guide to help new contributors get started #3806

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.

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

Open
wants to merge 6 commits into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
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
17 changes: 15 additions & 2 deletions website/content/en/docs/dev/_index.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,17 @@

---
title: Developers' guide
weight: 500
Title: Developer's Guide

Weight: 500
---

Lima is an open-source tool that allows you to run Linux virtual machines on both macOS and Linux.

## Quick Start for Contributors

- For more information on the project architecture, visit [Lima on DeepWiki](https://deepwiki.com)
- The main source code is located in the 'cmd/' and 'pkg/' directories.
- If you wish to contribute, please see [CONTRIBUTING.md](../../../../.github/CONTRIBUTING.md).
- Have any questions or ideas? To share them, create a GitHub issue or a discussion.
- Run the'make help' command in your terminal to see what other test commands you can use.
- For additional information on the documentation, please visit ([lima-vm.io](https://lima-vm.io)