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.

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

docs: update readme #2

Merged
merged 5 commits into from
Oct 25, 2024
Merged
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
58 changes: 22 additions & 36 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,41 +1,27 @@
![Penpot Desktop](https://europe1.discourse-cdn.com/standard20/uploads/penpot/original/2X/b/bc6c290e4566bc12f8afa162bae80ffb20a7c7f5.jpeg)
> This is unofficial software

<a href="https://www.producthunt.com/posts/penpot-desktop?utm_source=badge-featured&utm_medium=badge&utm_souce=badge-penpot&#0045;desktop" target="_blank"><img src="https://api.producthunt.com/widgets/embed-image/v1/featured.svg?post_id=371642&theme=dark" alt="Penpot&#0032;Desktop - A&#0032;desktop&#0045;like&#0032;experience&#0032;for&#0032;Penpot | Product Hunt" style="width: 250px; height: 54px;" width="250" height="54"/></a> <a href="https://notbyai.fyi"><img width="150" src="https://md.sudovanilla.org/images/written-by-human-not-by-ai-white.svg" alt="Written by Human, Not by AI"></a>

# Penpot Desktop
Penpot Desktop delivers a desktop-like experience for Penpot users with the additional of integrating tabs to conveniently traverse back and forth between projects. Offline support is available through the select your own instance option in settings, as well as the theme settings that may be applied to either the entire desktop app or simply the Penpot dashboard.

## Quick Links
Endusers:
- [FAQ](https://sudovanilla.org/docs/penpot-desktop/FAQ.md)
- Install [[Windows](https://sudovanilla.org/docs/penpot-desktop/install/WINDOWS.md), [Mac](https://sudovanilla.org/docs/penpot-desktop/install/MAC.md), [Linux](https://sudovanilla.org/docs/penpot-desktop/install/LINUX.md)]
- [System Requirements](https://sudovanilla.org/docs/penpot-desktop/install/INSTALL.md#system-requirements)
- [Changelog](https://sudovanilla.org/docs/penpot-desktop/CHANGELOG.md)

Developers:
- [FAQ for Developers](https://sudovanilla.org/docs/penpot-desktop/FAQ-for-developers.md)
- [Build Instructions](https://sudovanilla.org/docs/penpot-desktop/BUILD.md)
Penpot Desktop is an unofficial desktop application for the open-source design tool, Penpot.

## Building
### Requirements
- [NodeJS](https://nodejs.org/) v20
- [Python](https://www.python.org/)
- Supported OS:
- Windows 10 or newer
- macOS
- Linux
It delivers a desktop-like experience for Penpot users with the addition of integrated tabs to conveniently traverse back and forth between projects. Offline support is available through the "select your own instance" option, and theme settings can be applied to either the entire desktop app or just the Penpot dashboard.

### Install Packages
Before building anything, packages need to be installed first by your package manager, NodeJS should come with `npm` by default:
```bash
npm install
```

> Other package managers such as Yarn, PNPM, or Bun also work.

### Run Build
Once packages are installed, with no issues, you can run the build command:
```bash
npm run build
```
## Quick Links
- [Penpot](https://penpot.app/) - The official website for Penpot.
- [Old documentation](https://sudovanilla.org/docs/penpot-desktop/introduction/) - The old documentation for Penpot Desktop. New, updated documentation is in the works.

## Development and Building

1. Ensure the environment meets the following requirements:
- Supported OS:
- Windows 10 or newer
- macOS
- Linux
- [NodeJS](https://nodejs.org/) v20
- [Python](https://www.python.org/)
- [Git](https://git-scm.com/) (optional)
1. Clone the repository or download the source code.
1. Navigate to the project's directory.
1. Run `npm ci` to install packages.
*Other package managers such as Yarn, PNPM, or Bun should work as well.*
1. (Optional) Run `npm run dev` to start the application in development mode. This will open a new window with the application running.
1. Run `npm run build` to build the application. By default, it will build for the current OS and architecture, but you can pass flags to build for other platforms. See the [Electron Builder documentation](https://www.electron.build/cli) for more information.