Skip to content

Native iCloud apps for Windows and Linux, built in Rust. Notes, Reminders, Calendar, Contacts, Drive and Photos, offline and in sync with your iPhone.

Repo: the cleanup's text changes, which the last commit left out

Yashwanth Kamireddide3a07bf9197
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
index 2f13425..2df0a3d 100644
--- a/.github/CONTRIBUTING.md
+++ b/.github/CONTRIBUTING.md
@@ -2,20 +2,19 @@
Thank you for helping make Skykeep better. Whether it's a typo, a bug fix, a packaging recipe, a design idea or a new feature, it's welcome here.
-By taking part, you agree to the [Code of Conduct](CODE_OF_CONDUCT.md). Contributions are licensed under the project's license, [GPL-3.0-only](../LICENSE).
+Contributions are licensed under the project's license, [GPL-3.0-only](../LICENSE). Please be kind to each other.
**Contents:** [Ways to help](#ways-to-help) · [Set up](#set-up) · [Run it](#run-it) · [The checks](#the-checks) · [Code map](#code-map) · [Testing with iCloud](#testing-with-icloud) · [Ground rules](#ground-rules) · [UI and design](#ui-and-design) · [Commit style](#commit-style) · [Pull requests](#pull-requests)
## Ways to help
-- **Good first issues:** [labelled here](https://github.com/YashwanthKamireddi/Skykeep/labels/good%20first%20issue), each sized for an afternoon.
- **Bugs:** reproduce an open issue, or confirm a fix on your distribution or desktop.
- **Packaging:** Nix, Fedora COPR, Debian, Snap, winget. Each one brings Skykeep to more people.
- **Desktop integration:** GNOME, KDE and Windows shell integration.
- **Design:** see [UI and design](#ui-and-design).
- **Docs:** clearer install steps, FAQ answers, screenshots made with test data.
-For anything bigger than a small fix, please open an issue or a [Discussion](https://github.com/YashwanthKamireddi/Skykeep/discussions) first so we can agree on the approach before you invest the time.
+For anything bigger than a small fix, please open an issue first so we can agree on the approach before you invest the time.
## Set up
@@ -154,7 +153,7 @@ The crates keep the `quince-` prefix from the project's working name.
Designers are very welcome. Skykeep aims to feel like Apple's own apps: calm, familiar and quietly premium.
-- **Start with a Discussion** in the Ideas category: a sketch, mockup or screenshot and the problem it solves. Agreeing on the direction first saves everyone time.
+- **Start with an issue**: a sketch, mockup or screenshot and the problem it solves. Agreeing on the direction first saves everyone time.
- **Use the design system** in `src/components` (Toast, Confirm, EmptyState, PaneTitle, RowMenu and the rest) rather than one-off styles. Styles live in `src/styles`.
- **Light and dark, always.** Honour Reduce Transparency and Increase Contrast.
- **Motion:** no animation on large layers (whole panes, viewers, sheets). WebKitGTK on some Wayland compositors flickers, so these open and close instantly. Small, local motion is fine if it passes the frame-sampling suites in WebKit.
diff --git a/README.md b/README.md
index cad42d2..ab38797 100644
--- a/README.md
+++ b/README.md
@@ -21,13 +21,6 @@ Notes, Reminders, Calendar, Contacts, iCloud Drive and Photos as fast desktop ap
[![License: GPL-3.0](https://img.shields.io/badge/license-GPL--3.0-2f6fd6)](LICENSE)
[![Platforms](https://img.shields.io/badge/platforms-Linux%20%7C%20Windows-4a5568)](#install)
-<!-- Dynamic badges: enable once the repository is public and v0.1.0 is published.
-[![Latest release](https://img.shields.io/github/v/release/YashwanthKamireddi/Skykeep?sort=semver&color=2f6fd6)](https://github.com/YashwanthKamireddi/Skykeep/releases/latest)
-[![Downloads](https://img.shields.io/github/downloads/YashwanthKamireddi/Skykeep/total?color=4a5568)](https://github.com/YashwanthKamireddi/Skykeep/releases)
-Once live:
-[![AUR](https://img.shields.io/aur/version/skykeep?logo=archlinux&label=AUR)](https://aur.archlinux.org/packages/skykeep)
-[![Flathub](https://img.shields.io/flathub/v/io.github.yashwanthkamireddi.Skykeep?logo=flathub)](https://flathub.org/apps/io.github.yashwanthkamireddi.Skykeep)
--->
[Why](#why-skykeep) · [Features](#features) · [Install](#install) · [Privacy](#privacy-and-security) · [How it works](#how-it-works) · [FAQ](#faq) · [Contributing](#contributing)
@@ -344,7 +337,7 @@ What I'd like to add next:
- Skykeep on the AUR, Flathub and winget
- A code-signed Windows installer
-Got an idea or something you miss? Tell me in [Discussions](https://github.com/YashwanthKamireddi/Skykeep/discussions). I read everything.
+Got an idea or something you miss? [Open an issue](https://github.com/YashwanthKamireddi/Skykeep/issues). I read everything.
## Contributing
@@ -357,18 +350,10 @@ git clone https://github.com/YashwanthKamireddi/Skykeep.git
cd Skykeep && npm ci && ./run.sh
```
-New here? The [good first issues](https://github.com/YashwanthKamireddi/Skykeep/labels/good%20first%20issue) are small and friendly, and I'm happy to help you through your first one. Found a security problem? Please tell me privately, as [SECURITY.md](SECURITY.md) explains.
-
-<!-- Support: enable once GitHub Sponsors is approved (see .github/FUNDING.yml).
-## Support Skykeep
-
-I build Skykeep in my own time. If it saves you time, you can [sponsor it](https://github.com/sponsors/YashwanthKamireddi), which keeps it going.
--->
+Found a security problem? Please tell me privately, as [SECURITY.md](SECURITY.md) explains.
If Skykeep saves you a trip to the browser, a star helps other iPhone owners on Linux and Windows find it. Thank you.
## License
-Writing about Skykeep? The [press kit](press/README.md) has the fact sheet, logo and screenshots.
-
-The code is [GPL-3.0](LICENSE). The Skykeep™ name and logo are covered by a short [trademark note](TRADEMARKS.md): fork freely, under your own name. Skykeep is an independent project, not affiliated with or endorsed by Apple Inc.
+The code is [GPL-3.0](LICENSE). Skykeep is an independent project, not affiliated with or endorsed by Apple Inc. iCloud is a trademark of Apple Inc.
diff --git a/packaging/flatpak/README.md b/packaging/flatpak/README.md
index 097319f..73671b6 100644
--- a/packaging/flatpak/README.md
+++ b/packaging/flatpak/README.md
@@ -114,7 +114,7 @@ flatpak run --command=flatpak-builder-lint org.flatpak.Builder repo repo
- Point the git source at the public repository at a release tag and commit.
- Set the v0.1.0 `<release date>` in both metainfo files (it's a 2099-01-01 placeholder).
-- `<screenshots>` point at the press kit's `press/screenshots/png/*-light.png` on
+- `<screenshots>` point at the `docs/media/screenshots/*-light.png` on
`raw.githubusercontent.com/…/main`. They resolve once the repository is public. Flathub's
linter also asks for `<branding>` colours, which haven't been added yet.
- Confirm HEIC decodes and the keyring session survives a restart inside the sandbox.
diff --git a/packaging/flatpak/io.github.yashwanthkamireddi.Skykeep.metainfo.xml b/packaging/flatpak/io.github.yashwanthkamireddi.Skykeep.metainfo.xml
index 22c73bf..2e7f619 100644
--- a/packaging/flatpak/io.github.yashwanthkamireddi.Skykeep.metainfo.xml
+++ b/packaging/flatpak/io.github.yashwanthkamireddi.Skykeep.metainfo.xml
@@ -63,19 +63,19 @@
<screenshots>
<screenshot type="default">
<caption>Notes, in their folders</caption>
- <image type="source">https://raw.githubusercontent.com/YashwanthKamireddi/Skykeep/main/press/screenshots/png/notes-light.png</image>
+ <image type="source">https://raw.githubusercontent.com/YashwanthKamireddi/Skykeep/main/docs/media/screenshots/notes-light.png</image>
</screenshot>
<screenshot>
<caption>Reminders, in their lists</caption>
- <image type="source">https://raw.githubusercontent.com/YashwanthKamireddi/Skykeep/main/press/screenshots/png/reminders-light.png</image>
+ <image type="source">https://raw.githubusercontent.com/YashwanthKamireddi/Skykeep/main/docs/media/screenshots/reminders-light.png</image>
</screenshot>
<screenshot>
<caption>Calendar</caption>
- <image type="source">https://raw.githubusercontent.com/YashwanthKamireddi/Skykeep/main/press/screenshots/png/calendar-light.png</image>
+ <image type="source">https://raw.githubusercontent.com/YashwanthKamireddi/Skykeep/main/docs/media/screenshots/calendar-light.png</image>
</screenshot>
<screenshot>
<caption>The photo library</caption>
- <image type="source">https://raw.githubusercontent.com/YashwanthKamireddi/Skykeep/main/press/screenshots/png/photos-light.png</image>
+ <image type="source">https://raw.githubusercontent.com/YashwanthKamireddi/Skykeep/main/docs/media/screenshots/photos-light.png</image>
</screenshot>
</screenshots>
diff --git a/packaging/io.github.yashwanthkamireddi.Skykeep.metainfo.xml b/packaging/io.github.yashwanthkamireddi.Skykeep.metainfo.xml
index fc29f6c..422ca9a 100644
--- a/packaging/io.github.yashwanthkamireddi.Skykeep.metainfo.xml
+++ b/packaging/io.github.yashwanthkamireddi.Skykeep.metainfo.xml
@@ -60,19 +60,19 @@
<screenshots>
<screenshot type="default">
<caption>Notes, in their folders</caption>
- <image type="source">https://raw.githubusercontent.com/YashwanthKamireddi/Skykeep/main/press/screenshots/png/notes-light.png</image>
+ <image type="source">https://raw.githubusercontent.com/YashwanthKamireddi/Skykeep/main/docs/media/screenshots/notes-light.png</image>
</screenshot>
<screenshot>
<caption>Reminders, in their lists</caption>
- <image type="source">https://raw.githubusercontent.com/YashwanthKamireddi/Skykeep/main/press/screenshots/png/reminders-light.png</image>
+ <image type="source">https://raw.githubusercontent.com/YashwanthKamireddi/Skykeep/main/docs/media/screenshots/reminders-light.png</image>
</screenshot>
<screenshot>
<caption>Calendar</caption>
- <image type="source">https://raw.githubusercontent.com/YashwanthKamireddi/Skykeep/main/press/screenshots/png/calendar-light.png</image>
+ <image type="source">https://raw.githubusercontent.com/YashwanthKamireddi/Skykeep/main/docs/media/screenshots/calendar-light.png</image>
</screenshot>
<screenshot>
<caption>The photo library</caption>
- <image type="source">https://raw.githubusercontent.com/YashwanthKamireddi/Skykeep/main/press/screenshots/png/photos-light.png</image>
+ <image type="source">https://raw.githubusercontent.com/YashwanthKamireddi/Skykeep/main/docs/media/screenshots/photos-light.png</image>
</screenshot>
</screenshots>