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.

Sign up for GitHub

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

Jump to bottom

Reading through and updating README.md (attempt 2) #20

Merged
merged 19 commits into from
Apr 9, 2023
Merged

Reading through and updating README.md (attempt 2) #20

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
73ab39c
README: SfOS Wiki doesn't exist, TJC -> SfOS Forum
Mikaela Sep 4, 2021
849bef9
README: remove OwnKeepass
Mikaela Sep 4, 2021
ce221ed
Remove SailfishApps & Deploy
Mikaela Sep 4, 2021
dc70e65
README: replace the riot.im (!) URLs with matrix URI scheme
Mikaela Sep 4, 2021
8a7813e
README.md: search&replace for OFTC
Mikaela Sep 4, 2021
3d2eb3a
Remove IRC & Matrix of SfOS Hackclub Helsinki
Mikaela Sep 4, 2021
a84c464
README: add link to forum thread on Android->SfOS apps
Mikaela Sep 4, 2021
51001b3
add .pre-commit-config.yaml for doctoc & run it
Mikaela Mar 13, 2023
a51aeb2
README.md: mention TJC, Docs, update meeting channel name
Mikaela Mar 13, 2023
1aaf328
README.md: replace KiwiIRC with OFTC webchat
Mikaela Mar 13, 2023
6a276c5
README.md: update IRC & Matrix rooms
Mikaela Mar 13, 2023
aace854
README.md: German & Finnish Telegram links are expired
Mikaela Mar 13, 2023
587858c
README.md: add Arabic Telegram & Matrix
Mikaela Mar 13, 2023
6344391
README.md: remove the Chinese IRC (0 users)
Mikaela Mar 13, 2023
24106af
README.md: restore Deploy section
Mikaela Mar 13, 2023
3cb57b5
.pre-commit-config.yaml: allow having files without doctoc just in case
Mikaela Mar 25, 2023
2397f99
contributing.md: mention pre-commit
Mikaela Mar 25, 2023
e25ff15
.gitattributes: simplify and enforce lf line-endings
Mikaela Mar 25, 2023
03f425d
add barebones .editorconfig
Mikaela Mar 25, 2023
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
5 changes: 5 additions & 0 deletions .editorconfig
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
root = true

[*]
end_of_line = lf
charset = utf-8
Comment on lines +1 to +5
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

https://editorconfig.org/ configures settings that will apply to multiple text editors just for this repository.

  • root=true means that .editorconfig capable text-editors (see link earlier) won't go looking for configuration from top leve l directories.
  • line endings are enforced to be lf, which the editors should detect automatically though, as a pair to .gitattributes eol=lf and to workaround Unusable as 'pre-commit' hook, since it will always fail. thlorenz/doctoc#161 just in case anyone uses Windows.
  • well I certainly hope everyone uses utf-8

3 changes: 1 addition & 2 deletions .gitattributes
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1 @@
* text=auto
README.md merge=union
* text=auto eol=lf merge=union
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There isn't any complicated programming language code here, so I think merge=union should be a safe strategy for all files.

eol=lf workarounds thlorenz/doctoc#161 in case anyone uses Windows.

7 changes: 7 additions & 0 deletions .pre-commit-config.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# https://pre-commit.com/
Mikaela marked this conversation as resolved.
Show resolved Hide resolved
repos:
- repo: https://github.com/thlorenz/doctoc
rev: v2.2.0
hooks:
- id: doctoc
args: [--update-only]
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This makes doctoc not force itself on everything, while it can be enabled by adding the following anywhere in a file:

<!-- START doctoc -->
<!-- END doctoc -->

However it looks like all files were doctoced before I enabled it, and I don't know whether non-doctoced are desirable.

74 changes: 37 additions & 37 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,39 +9,39 @@ Sailfish OS is a mobile operating system based on open source and developed by t
## Contents

<!-- START doctoc generated TOC please keep comment here to allow auto update -->

<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->

<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->

* [Sailfish OS](#sailfish-os)
* [Applications](#applications)
* [Tips and Tricks](#tips-and-tricks)
* [Instant Messaging](#instant-messaging)
* [In English](#in-english)
* [In German](#in-german)
* [In Finnish](#in-finnish)
* [In Spanish](#in-spanish)
* [In Italian](#in-italian)
* [In Turkish](#in-turkish)
* [In Chinese](#in-chinese)
* [In Russian](#in-russian)
* [Academic](#academic)
* [Related](#related)
* [License](#license)
- [Sailfish OS](#sailfish-os)
- [Applications](#applications)
- [Deploy](#deploy)
- [Tips and Tricks](#tips-and-tricks)
- [Instant Messaging](#instant-messaging)
- [In English](#in-english)
- [In German](#in-german)
- [In Finnish](#in-finnish)
- [In Spanish](#in-spanish)
- [In Italian](#in-italian)
- [In Turkish](#in-turkish)
- [In Chinese](#in-chinese)
- [In Russian](#in-russian)
- [In Arabic](#in-arabic)
- [Academic](#academic)
- [Related](#related)
- [License](#license)

<!-- END doctoc generated TOC please keep comment here to allow auto update -->

## Sailfish OS

* [Sailfish Wiki](https://sailfishos.org/about/) - Wiki about Sailfish OS
* [Sailfish OS Community](https://sailfishos.org/community/) - About Sailfish OS
community
* [together.jolla.com](https://together.jolla.com/questions/) - The place to ask
* [SailfishOS Forum](https://forum.sailfishos.org) - The place to ask
questions
* [together.jolla.com](https://together.jolla.com/questions/) - Precedor of SailfishOS Forum, contains historical information
Mikaela marked this conversation as resolved.
Show resolved Hide resolved
* [Sailfish OSS](https://wiki.merproject.org/wiki/SailfishOSS) - List of the
different components of Sailfish OS and whether they are OSS
* [Developer Documentation](https://sailfishos.org/wiki/SailfishOS) -
* [SailfishOS Documentation](https://sailfishos.org/wiki/SailfishOS) -
Mikaela marked this conversation as resolved.
Show resolved Hide resolved
Documentation for Sailfish OS developers
* [SailfishOS Ports List](https://wiki.merproject.org/wiki/Adaptations/libhybris) -
List of unofficial SailfishOS ports
Expand All @@ -50,58 +50,54 @@ Sailfish OS is a mobile operating system based on open source and developed by t

* [Storeman](https://github.com/mentaljam/harbour-storeman) - Unofficial native
OpenRepos.net client for Sailfish OS
* [OwnKeepass](https://github.com/jobe-m/ownkeepass) - Password safe
application for Sailfish OS built on top of KeepassX
Mikaela marked this conversation as resolved.
Show resolved Hide resolved
* [Working Hours Tracker](https://wht.olpe.fi/) - Easy to use and simple
Working Hours Tracker for SailfishOS
* [Sailfish Apps](https://github.com/sailfishapps) - Unofficial Sailfish OS third party open source apps collection

## Deploy

* [therecipe/qt](https://github.com/therecipe/qt) - QML Cross-platform Apps with docker

## Tips and Tricks

* [Sailfish Useful Commands](https://github.com/olpeh/sailfish-useful-commands) -
Collection of useful commands that are not so easy to remember
* [Equivalents in Sailfish](https://github.com/maidis/equivalentsinsailfish) - List that shows Android apps and their Sailfish equivalents
* [List of Android -> SailfishOS applications](https://forum.sailfishos.org/t/list-of-android-sailfish-os-applications/6866)
* [Sailfish OS Cheat Sheet](https://sailfishos.org/wiki/Sailfish_OS_Cheat_Sheet) - Collection of Development Commands

## Instant Messaging

### In English

* SailfishOS Fan Club
* [Telegram](https://t.me/joinchat/gkQEMR5cOh1iMTA8)
* [Matrix](https://riot.im/app/#/room/#jfc:matrix.org)
* [IRC](https://kiwiirc.com/client/irc.freenode.net:+6697/#jollafanclub)
* [Telegram](https://t.me/joinchat/gkQEMR5cOh1iMTA8)
* [Matrix](https://matrix.to/#/%23_oftc_%23sailfishos-fanclub%3Amatrix.org)
* [IRC](https://webchat.oftc.net/?channels=#sailfishos-fanclub)
* Sailfish OS-meeting

* [Telegram READ-ONLY](https://t.me/joinchat/AAAAAFcbasJX67Fu-aGxxQ)
* [Matrix](https://riot.im/app/#/room/#freenode_#mer-meeting)
* [IRC](https://kiwiirc.com/client/irc.freenode.net:+6697/#Mer-meeting)
* [Matrix](https://matrix.to/#/%23_oftc_%23sailfishos-meeting%3Amatrix.org)
* [IRC](https://webchat.oftc.net/?channels=#sailfishos-meeting)

* #sailfishos-porters
* [Telegram](https://t.me/sailfishos_porters)
* [Matrix](https://riot.im/app/#/room/#freenode_#sailfishos-porters:matrix.org)
* [IRC](https://kiwiirc.com/client/irc.freenode.net:+6697/#sailfishos-porters)
* [Matrix](https://matrix.to/#/%23_oftc_%23sailfishos-porters%3Amatrix.org)
* [IRC](https://webchat.oftc.net/?channels=#sailfishos-porters)
* NemoMobile
* [Telegram](https://t.me/NemoMobile)
* [Matrix](https://riot.im/app/#/room/#freenode_#nemomobile:matrix.org)
* [IRC](https://kiwiirc.com/client/irc.freenode.net:+6697/#NemoMobile)
* [Matrix](https://matrix.to/#/%23nemomobile%3Amatrix.org)
* SfOS QML App dev
* [Telegram](https://t.me/joinchat/Az9rWwlOc_JbRyYH7hxG7Q)

### In German

* Deutsche Sailfish OS Community
* [Telegram](https://t.me/joinchat/CCMYXQnxqdpVWVooiTdWTQ)
* Telegram

### In Finnish

* SailfishOS Hackclub Helsinki
* [Telegram](https://telegram.me/joinchat/AWx9iQi71psKR-isKktNTQ)
* [Matrix](https://riot.im/app/#/room/#sailfishos-hackclub-helsinki:disroot.org)
* [IRC](https://kiwiirc.com/client/irc.freenode.net:+6697/#sailfish-hackclub-hki)
* Telegram

### In Spanish

Expand All @@ -126,7 +122,6 @@ Sailfish OS is a mobile operating system based on open source and developed by t

* SailfishOS Fan Club
* [Telegram](https://t.me/jollacn)
* [IRC](https://kiwiirc.com/client/irc.freenode.net:+6697/#jolla-cn)
* [旗鱼俱乐部](https://sailfishos.club)
* [QQ 群](https://jq.qq.com/?_wv=1027&k=5Ci7vyS)

Expand All @@ -135,6 +130,11 @@ Sailfish OS is a mobile operating system based on open source and developed by t
* [Sailfish OS Telegram chat](https://t.me/sailfishos)
* [Sailfish OS Pub Telegram chat](https://t.me/sailfishos_pub)

### In Arabic

* [Telegram](https://t.me/SFOS_AR)
* [Matrix](https://matrix.to/#/%23SFOS_AR%3Amatrix.org)

## Academic
* [Asterism: Decentralized File Sharing Application for Mobile Devices](https://www.researchgate.net/publication/330758943_Asterism_Decentralized_File_Sharing_Application_for_Mobile_Devices)
* [Method and Tools for Automated End-to-end Testing of Applications for Sailfish OS](https://dl.acm.org/citation.cfm?id=3180065)
Expand Down
10 changes: 10 additions & 0 deletions contributing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@

- [Contribution Guidelines](#contribution-guidelines)
- [Updating your PR](#updating-your-pr)
- [pre-commit](#pre-commit)

<!-- END doctoc generated TOC please keep comment here to allow auto update -->

Expand Down Expand Up @@ -32,3 +33,12 @@ edit your PR before we merge it. There's no need to open a new PR, just edit
the existing one. If you're not sure how to do that,
[here is a guide](https://github.com/RichardLitt/knowledge/blob/master/github/amending-a-commit-guide.md)
on the different ways you can update your PR so that we can merge it.

## pre-commit
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have a feeling I cannot English here.


Please consider [installing pre-commit](https://pre-commit.com/#installation)
to ensure that the tables of contents are kept up-to-date.

Once `pre-commit` is installed, please run `pre-commit install` in your
local clone of this repository to have it executed automatically when
`git commit`ing. You can also run it manually by `pre-commit run --all-files`.