Skip to content
Merged
Show file tree
Hide file tree
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
67 changes: 49 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

# Butterfly

> 🎨 Powerful, minimalistic, cross-platform, opensource note-taking app 🎨
> 🎨 Take notes, draw freely, and organize ideas across an endless workspace 🎨

[![Latest release)](https://img.shields.io/github/v/release/LinwoodDev/butterfly?color=EBB733&style=for-the-badge&logo=github&logoColor=EBB733)](https://github.com/LinwoodDev/butterfly/releases)
[![GitHub License badge](https://img.shields.io/github/license/LinwoodDev/butterfly?color=EBB733&style=for-the-badge&logo=data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIxOTIiIGhlaWdodD0iMTkyIiBmaWxsPSIjZWJiNzMzIiB2aWV3Qm94PSIwIDAgMjU2IDI1NiI%2BPHJlY3Qgd2lkdGg9IjI1NiIgaGVpZ2h0PSIyNTYiIGZpbGw9Im5vbmUiPjwvcmVjdD48cmVjdCB4PSIzMiIgeT0iNDgiIHdpZHRoPSIxOTIiIGhlaWdodD0iMTYwIiByeD0iOCIgc3Ryb2tlLXdpZHRoPSIxNiIgc3Ryb2tlPSIjZWJiNzMzIiBzdHJva2UtbGluZWNhcD0icm91bmQiIHN0cm9rZS1saW5lam9pbj0icm91bmQiIGZpbGw9Im5vbmUiPjwvcmVjdD48bGluZSB4MT0iNzYiIHkxPSI5NiIgeDI9IjE4MCIgeTI9Ijk2IiBmaWxsPSJub25lIiBzdHJva2U9IiNlYmI3MzMiIHN0cm9rZS1saW5lY2FwPSJyb3VuZCIgc3Ryb2tlLWxpbmVqb2luPSJyb3VuZCIgc3Ryb2tlLXdpZHRoPSIxNiI%2BPC9saW5lPjxsaW5lIHgxPSI3NiIgeTE9IjEyOCIgeDI9IjE4MCIgeTI9IjEyOCIgZmlsbD0ibm9uZSIgc3Ryb2tlPSIjZWJiNzMzIiBzdHJva2UtbGluZWNhcD0icm91bmQiIHN0cm9rZS1saW5lam9pbj0icm91bmQiIHN0cm9rZS13aWR0aD0iMTYiPjwvbGluZT48bGluZSB4MT0iNzYiIHkxPSIxNjAiIHgyPSIxODAiIHkyPSIxNjAiIGZpbGw9Im5vbmUiIHN0cm9rZT0iI2ViYjczMyIgc3Ryb2tlLWxpbmVjYXA9InJvdW5kIiBzdHJva2UtbGluZWpvaW49InJvdW5kIiBzdHJva2Utd2lkdGg9IjE2Ij48L2xpbmU%2BPC9zdmc%2B)](https://github.com/LinwoodDev/butterfly/blob/main/LICENSE)
Expand All @@ -28,26 +28,57 @@

---

Butterfly is a note-taking app where your ideas come first. You can paint, add texts, and export them easily on every device. This app works on Android, Windows, Linux, and in the web.
<img
src="docs/src/assets/img/showcase-canvas.png"
alt="Butterfly canvas showing notes, drawings, pages, and editing tools"
width="100%"
/>

## Think visually. Keep your canvas yours.

Butterfly is an open-source app for people who think better with space around their ideas. Instead of writing everything from top to bottom on a fixed page, you get an endless workspace where you can place notes, sketches, diagrams, images, and documents wherever they make sense.

Use it for class notes, meeting notes, research, math, worksheets, planning, whiteboarding, storyboards, product sketches, or any project that starts messy and needs room to grow. Write by hand with a stylus, touch, or mouse, type text and Markdown, add shapes and lines, place images and photos, import PDFs, SVGs, and image files, then export your work as PDF, SVG, images, or portable Butterfly files.

## Features

* **⚡ Simple and intuitive:** Every tool is in the right place. Open the app and start drawing. Change your tools by clicking on them.
* **🎨 Customizable:** Change everything to your needs. Choose your custom color, create a palette, and add your pages to the paper. The paper has an infinite size, perfect for your ideas and notes.
* **📝 Supports your favorite formats:** Import and export are supported for images, PDF and SVG. Open these files directly to edit them.
* **📱 Works on every device:** The app is available for Android, Windows, Linux, and in the web. You can use it on your phone, tablet, or computer.
* **💻 Choose where your data is stored:** You can choose to store your data locally or in your favorite cloud (WebDAV). You can also export your data to a file and import it again.
* **🌐 Available in many languages:** The app is available in many languages. Help us to translate this app to your language.
* **📚 FOSS:** The app is open source and free. You can contribute to the project and help to make it better.
* **🔋 Use it offline:** You can use the app offline. You can draw, paint, and export your notes without an internet connection.
* **🖊️ Use your favorite stylus:** The app supports stylus and touch devices. You can draw and paint with your favorite stylus.
* **📜 Write text:** You can write text on your notes. You can change the font, size, and color.
* **📸 Take photos:** You can take photos and add them to your notes. You can also import photos from your gallery.
* **⚙️ Editable:** You can change the size, color, and position of every element after you added it to your note.
* **🟦 Add shapes:** You can add shapes to your notes. You can choose between a rectangle, triangle, circle and line.
* **🔳 Structure your notes:** Add areas and waypoints to your notes to keep them organized.

Try it [now](http://butterfly.linwood.dev/downloads)!
* **✍️ Tunable drawing tools:** Shape each pen around your workflow with smoothing, thinning, pressure behavior, zoom-dependent strokes, and shape detection.
* **🧩 Mixed content:** Combine handwriting, text, Markdown, shapes, images, photos, PDFs, SVGs, rulers, grids, textures, laser pointer notes, and presentation tools.
* **🛠️ Always editable:** Move, resize, recolor, reorder, and refine most elements later instead of starting over.
* **🗂️ Project structure:** Organize large documents with multiple pages, page folders, layers, named areas, and waypoints.
* **🎨 Reusable setup:** Save templates, packs, palettes, stamps, and text styles so your favorite layouts and tools follow you.
* **🚀 Quick start:** Jump in from recent files, search, folders, imports, quick-start templates, and storage locations.
* **🔒 Local first:** Work offline, store files locally, choose a different data directory, or connect WebDAV and Nextcloud.
* **📤 Flexible export:** Share your work as PDF, SVG, images, or portable Butterfly files.
* **🤝 Experimental collaboration:** Work together with end-to-end encrypted sessions through Swamp or a self-hosted WebSocket server.

## Your work belongs to you

Your files stay under your control. Work offline, store documents on your device, choose a different data directory, or connect WebDAV and Nextcloud if you want your own sync setup. There is no required account, no required subscription, and no required proprietary cloud.

Butterfly is free, community translated, available on phones, tablets, desktops, and the web, and developed in public under the AGPL-3.0 license.

<p align="center">
<img
src="docs/src/assets/img/showcase-tools.png"
alt="Butterfly tool settings"
width="49%"
/>
<img
src="docs/src/assets/img/showcase-templates.png"
alt="Butterfly template browser"
width="49%"
/>
</p>

## Get Butterfly

Try Butterfly in your browser, install it on your devices, or explore the documentation:

* [Download Butterfly](https://butterfly.linwood.dev/downloads)
* [Try the web app](https://web.butterfly.linwood.dev) (Chromium-based browsers are recommended)
* [Read the documentation](https://butterfly.linwood.dev/docs/v2/intro)
* [Join the community](https://butterfly.linwood.dev/community)

---

Expand Down
28 changes: 19 additions & 9 deletions app/linux/debian/DEBIAN/control
Original file line number Diff line number Diff line change
@@ -1,9 +1,19 @@
Package: linwood-butterfly
Version: 2.6.0-rc.2
Section: base
Priority: optional
Homepage: https://github.com/LinwoodDev/butterfly
Architecture: amd64
Maintainer: Linwood <contact@linwood.dev>
Description: Linwood Butterfly
Butterfly is a note app where your ideas come first. You can paint, add texts and export them easily on every device. This app works on android, windows, linux and in the web.
Package: linwood-butterfly
Version: 2.6.0-rc.2
Section: base
Priority: optional
Homepage: https://github.com/LinwoodDev/butterfly
Architecture: amd64
Maintainer: Linwood <contact@linwood.dev>
Description: Take notes, draw freely, and organize ideas across an endless workspace
Butterfly is an open-source app for people who think better with space around their ideas. Instead of writing everything from top to bottom on a fixed page, you get an endless workspace where you can place notes, sketches, diagrams, images, and documents wherever they make sense.
.
Use it for class notes, meeting notes, research, math, worksheets, planning, whiteboarding, storyboards, product sketches, or any project that starts messy and needs room to grow. Write by hand with a stylus, touch, or mouse, type text and Markdown, add shapes and lines, place images and photos, import PDFs, SVGs, and image files, then export your work as PDF, SVG, images, or portable Butterfly files.
.
Butterfly tries to stay out of your way while you work. Recent files, quick-start templates, search, folders, imports, page navigation, and tool settings are close when you need them, but the document stays at the center. You can begin with a plain page, ruled paper, a grid, dotted paper, music paper, or your own template.
.
As your document grows, Butterfly gives you ways to keep it understandable. Split work into pages and page folders, use layers, mark important places with areas and waypoints, save reusable parts in packs, and keep palettes and text styles ready for the next document. Almost everything you add remains editable, so you can move, resize, recolor, reorder, and refine your work later instead of starting over.
.
Your files stay under your control. Work offline, store documents on your device, choose a different data directory, or connect WebDAV and Nextcloud if you want your own sync setup. There is no required account, no required subscription, and no required proprietary cloud.
.
Butterfly is free, community translated, available on phones, tablets, desktops, and the web, and developed in public under the AGPL-3.0 license.
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[Desktop Entry]
Name=Linwood Butterfly
Comment=Powerful, minimalistic, cross-platform, opensource note-taking app
Comment=Take notes, draw freely, and organize ideas across an endless workspace
Exec=butterfly %f
Icon=dev.linwood.butterfly
Terminal=false
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<developer id="dev.linwood">
<name>Linwood</name>
</developer>
<summary>Draw and organize ideas</summary>
<summary>Infinite-canvas notes and sketches</summary>
<metadata_license>CC0-1.0</metadata_license>
<project_license>AGPL-3.0-only</project_license>
<supports>
Expand All @@ -27,38 +27,27 @@
<url type="vcs-browser">https://github.com/LinwoodDev/Butterfly.git</url>
<url type="contribute">https://github.com/LinwoodDev/Butterfly/blob/develop/CONTRIBUTING.md</url>
<description>
<p>Butterfly is a note-taking app where your ideas come first. You can paint, add texts, and
export them easily on every device. This app works on Android, Windows, Linux, and in the web.</p>
<p>Features:</p>
<ul>
<li>Simple and intuitive: Every tool is in the right place. Open the app and start drawing.
Change your tools by clicking on them.</li>
<li>Customizable: Change everything to your needs. Choose your custom color, create a palette,
and add your pages to the paper. The paper has an infinite size, perfect for your ideas and
notes.</li>
<li>Supports your favorite formats: Import and export are supported for images, PDF and SVG.
Open these files directly to edit them.</li>
<li>Works on every device: The app is available for Android, Windows, Linux, and in the web.
You can use it on your phone, tablet, or computer.</li>
<li>Choose where your data is stored: You can choose to store your data locally or in your
favorite cloud (WebDAV). You can also export your data to a file and import it again.</li>
<li>Available in many languages: The app is available in many languages. Help us to translate
this app to your language.</li>
<li>FOSS: The app is open source and free. You can contribute to the project and help to make
it better.</li>
<li>Use it offline: You can use the app offline. You can draw, paint, and export your notes
without an internet connection.</li>
<li>Use your favorite stylus: The app supports stylus and touch devices. You can draw and
paint with your favorite stylus.</li>
<li>Write text: You can write text on your notes. You can change the font, size, and color.</li>
<li>Take photos: You can take photos and add them to your notes. You can also import photos
from your gallery.</li>
<li>Editable: You can change the size, color, and position of every element after you added it
to your note.</li>
<li>Add shapes: You can add shapes to your notes. You can choose between a rectangle,
triangle, circle and line.</li>
<li>Structure your notes: Add areas and waypoints to your notes to keep them organized.</li>
</ul>
<p>Butterfly is an open-source app for people who think better with space around their ideas. Instead of
writing everything from top to bottom on a fixed page, you get an endless workspace where you can place
notes, sketches, diagrams, images, and documents wherever they make sense.</p>
<p>Use it for class notes, meeting notes, research, math, worksheets, planning, whiteboarding, storyboards,
product sketches, or any project that starts messy and needs room to grow. Write by hand with a stylus,
touch, or mouse, type text and Markdown, add shapes and lines, place images and photos, import PDFs,
SVGs, and image files, then export your work as PDF, SVG, images, or portable Butterfly files.</p>
<p>Butterfly tries to stay out of your way while you work. Recent files, quick-start templates, search,
folders, imports, page navigation, and tool settings are close when you need them, but the document
stays at the center. You can begin with a plain page, ruled paper, a grid, dotted paper, music paper,
or your own template.</p>
<p>As your document grows, Butterfly gives you ways to keep it understandable. Split work into pages and
page folders, use layers, mark important places with areas and waypoints, save reusable parts in packs,
and keep palettes and text styles ready for the next document. Almost everything you add remains
editable, so you can move, resize, recolor, reorder, and refine your work later instead of starting
over.</p>
<p>Your files stay under your control. Work offline, store documents on your device, choose a different
data directory, or connect WebDAV and Nextcloud if you want your own sync setup. There is no required
account, no required subscription, and no required proprietary cloud.</p>
<p>Butterfly is free, community translated, available on phones, tablets, desktops, and the web, and
developed in public under the AGPL-3.0 license.</p>
</description>
<screenshots>
<screenshot type="default">
Expand Down
2 changes: 1 addition & 1 deletion app/linux/rpm/linwood-butterfly.desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[Desktop Entry]
Name=Linwood Butterfly
Comment=Powerful, minimalistic, cross-platform, opensource note-taking app
Comment=Take notes, draw freely, and organize ideas across an endless workspace
Exec=/usr/bin/linwood-butterfly %f
Icon=/usr/share/linwood-butterfly/data/flutter_assets/images/logo.svg
Terminal=false
Expand Down
14 changes: 12 additions & 2 deletions app/linux/rpm/linwood-butterfly.spec
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
Name: linwood-butterfly
Version: 1.0.0
Release: 1%{?dist}
Summary: Powerful, minimalistic, cross-platform, opensource note-taking app
Summary: Take notes, draw freely, and organize ideas across an endless workspace
BuildArch: %{_target_cpu}
URL: https://github.com/LinwoodDev/Butterfly
License: AGPLv3
Expand All @@ -16,7 +16,17 @@ Source0: %{name}-%{version}.tar.gz
Requires: bash

%description
Butterfly is a note app where your ideas come first. You can paint, add texts and export them easily on every device. This app works on Android, Windows, Linux, and in the web.
Butterfly is an open-source app for people who think better with space around their ideas. Instead of writing everything from top to bottom on a fixed page, you get an endless workspace where you can place notes, sketches, diagrams, images, and documents wherever they make sense.

Use it for class notes, meeting notes, research, math, worksheets, planning, whiteboarding, storyboards, product sketches, or any project that starts messy and needs room to grow. Write by hand with a stylus, touch, or mouse, type text and Markdown, add shapes and lines, place images and photos, import PDFs, SVGs, and image files, then export your work as PDF, SVG, images, or portable Butterfly files.

Butterfly tries to stay out of your way while you work. Recent files, quick-start templates, search, folders, imports, page navigation, and tool settings are close when you need them, but the document stays at the center. You can begin with a plain page, ruled paper, a grid, dotted paper, music paper, or your own template.

As your document grows, Butterfly gives you ways to keep it understandable. Split work into pages and page folders, use layers, mark important places with areas and waypoints, save reusable parts in packs, and keep palettes and text styles ready for the next document. Almost everything you add remains editable, so you can move, resize, recolor, reorder, and refine your work later instead of starting over.

Your files stay under your control. Work offline, store documents on your device, choose a different data directory, or connect WebDAV and Nextcloud if you want your own sync setup. There is no required account, no required subscription, and no required proprietary cloud.

Butterfly is free, community translated, available on phones, tablets, desktops, and the web, and developed in public under the AGPL-3.0 license.

%prep
%setup -q
Expand Down
2 changes: 1 addition & 1 deletion app/pubspec.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
name: butterfly
description: Powerful, minimalistic, cross-platform, opensource note-taking app
description: Take notes, draw freely, and organize ideas across an endless workspace

publish_to: none

Expand Down
4 changes: 2 additions & 2 deletions docs/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
"@astrojs/react": "^6.0.5",
"@astrojs/starlight": "^0.42.0",
"@fontsource-variable/inter": "^5.3.0",
"@linwooddev/starlight-style": "github:LinwoodDev/style#1fe2f9532daa3a4d929763a65ab1c88e6e864654&path:/packages/starlight",
"@linwooddev/starlight-style": "github:LinwoodDev/style#5fd25f2e595873cefd3e61a081b9eaba881adfcf&path:/packages/starlight",
"@linwooddev/style": "github:LinwoodDev/style#efbdf8f05d4ef1cf6fec65c90194d30b68b3c64e&path:/packages/web",
"@phosphor-icons/react": "^2.1.10",
"@types/react": "^19.3.0",
Expand All @@ -29,7 +29,7 @@
"packageManager": "pnpm@12.4.1",
"devDependencies": {
"@vite-pwa/astro": "^1.2.0",
"sass": "^1.104.0",
"sass": "^1.104.1",
"sharp": "^0.35.4",
"vite-plugin-pwa": "^1.3.0",
"workbox-window": "^7.4.1"
Expand Down
Loading
Loading