Skip to content

Commit 423600d

Browse files
committed
doc: Explain desktop support is dev-only
1 parent 8619e8e commit 423600d

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

README.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -307,6 +307,31 @@ When adding new strings in the UI, we set them up to be translated.
307307
For details on how to do this, see the [translation doc](docs/translation.md).
308308

309309

310+
### Desktop support
311+
312+
This app is intended for use on mobile platforms, specifically
313+
Android and iOS.
314+
315+
On desktop platforms, we support running the app for development
316+
but not for general use. In particular this means:
317+
318+
* The layout and UI are designed for mobile. We don't spend time
319+
on adapting the app to desktop UI features or paradigms.
320+
321+
* External platform integrations (like opening a link,
322+
taking a photo, etc.) are built only for Android and iOS.
323+
We don't spend time making them work on other platforms.
324+
325+
* On the other hand the app runs, and core functionality works,
326+
on at least Linux and macOS. Currently no regular contributor
327+
uses it on Windows, but we accept fixes to keep it running there too.
328+
329+
The reason we support desktop platforms at all is that
330+
for development it's sometimes useful to run the app on desktop.
331+
For example, this makes it easy to resize the window arbitrarily,
332+
which can be helpful for testing layout behavior.
333+
334+
310335
## License
311336

312337
Copyright (c) 2022 Kandra Labs, Inc., and contributors.

0 commit comments

Comments
 (0)