Captain's Log for Sailfish OS

Captain's Log is a simple diary application for keeping track of your thoughts.

This repository contains the development of version 2.0.0 and upwards of Captain's Log. Previous versions were developed by the original author AlphaX2.

Features

• lockscreen to restrict access
• bookmark entries
• add tags
• browse your entries by different filters
• export your data to different file formats

Note: Captain's Log can hide your entries behind a protection code but it's nothing special. Your data is neither encrypted nor otherwise protected against a bad guy with physical (or SSH) access to your device.

Planned features

• attach images to your entries
• include voice notes
• improved translations

Permissions

Captain's Log requires the following permissions:

• Documents: required to export the database to different file formats

Help and support

You are welcome to leave a comment in the forum if you have any questions or ideas.

Translations

It would be wonderful if the app could be translated in as many languages as possible!

Translations are managed using Weblate. Please prefer this over pull request (which are still welcome, of course). If you just found a minor problem, you can also leave a comment in the forum or open an issue.

Please include the following details:

1. the language you were using
2. where you found the error
3. the incorrect text
4. the correct translation

Manually updating translations

Please prefer using Weblate over this. You can follow these steps to manually add or update a translation:

1. If it did not exist before, create a new catalog for your language by copying the base file translations/harbour-captains-log.ts. Then add the new translation to harbour-captains-log.pro.
2. Add yourself to the list of contributors in qml/pages/AboutPage.qml.
3. (optional) Translate the app's name in harbour-captains-log.desktop if there is a (short) native term for it in your language.

See the Qt documentation for details on how to translate date formats to your local format.

Building and contributing

Bug reports, and contributions for translations, bug fixes, or new features are always welcome!

1. Clone the repository by running git clone --recurse-submodules https://github.com/ichthyosaurus/harbour-captains-log.git
2. Apply necessary patches: git apply libs/*.patch
3. Open harbour-captains-log.pro in Sailfish OS IDE (Qt Creator for Sailfish)
4. To run on emulator, select the i486 target and press the run button
5. To build for the device, select the armv7hl target and click “deploy all”; the RPM packages will be in the RPMS folder

If you contribute, please do not forget to add yourself to the list of contributors in qml/pages/AboutPage.qml!

Donations

If you want to support my work, I am always happy if you buy me a cup of coffee through Liberapay.

Of course it would be much appreciated as well if you support this project by contributing to translations or code! See above how you can contribute 🎕.

License

Copyright (C) 2020-2024 Mirian Margiani

Copyright (C) 2020 AlphaX2

Captain's Log is Free Software released under the terms of the GNU General Public License v3 (or later). The source code is available on Github. All documentation is released under the terms of the GNU Free Documentation License v1.3 (or later).

This project follows the REUSE specification.