summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorcos <cos>2024-07-03 11:01:47 +0200
committercos <cos>2024-07-03 11:31:23 +0200
commit0cd0b022560b59531b13a430b360ae88272222ce (patch)
tree88cb52bd0d83788dcf21683a59f5857c8307615e
parent6cc2e77922bc9c7718255b94d7b1436fbb99f754 (diff)
downloadAntennaPodDbFixer-0cd0b022560b59531b13a430b360ae88272222ce.zip
Slight README improvements
Wrap long lines at 80 characters. Use reference-style link. Add the word "known" prior to situations, inviting for feedback on potential other causes.
-rw-r--r--README.md25
1 files changed, 18 insertions, 7 deletions
diff --git a/README.md b/README.md
index 2ef2e18..c55fc5f 100644
--- a/README.md
+++ b/README.md
@@ -1,13 +1,24 @@
-# AntennaPod Db Fixer
+# AntennaPod Db Fixer
-There are two situations in which the AntennaPod database might get broken:
+There are two known situations in which the AntennaPod database might get
+broken:
-- In a very old AntennaPod version, there were some issues with the database with all information (episodes, listening states, etc). While the cause is long fixed, your database might have been damaged (even when the app was working without issues). If a recent AntennaPod version makes changes to the damaged parts of the database, these damages may suddenly become a problem.
-- AntennaPod runs on a large number of devices and flash memory sometimes just fails.
+- In a very old AntennaPod version, there were some issues with the database
+ with all information (episodes, listening states, etc). While the cause is
+ long fixed, your database might have been damaged (even when the app was
+ working without issues). If a recent AntennaPod version makes changes to the
+ damaged parts of the database, these damages may suddenly become a problem.
+- AntennaPod runs on a large number of devices and flash memory sometimes just
+ fails.
-If AntennaPod detects a broken database, it dumps the broken database to the file `/sdcard/Android/data/de.danoeh.antennapod/CorruptedDatabaseBackup.db`.
+If AntennaPod detects a broken database, it dumps the broken database to the
+file `/sdcard/Android/data/de.danoeh.antennapod/CorruptedDatabaseBackup.db`.
-This script automates the recovery process, so one does not need to go through [the steps](https://antennapod.org/documentation/bugs-first-aid/database-error) manually.
+This script automates the recovery process, so one does not need to go through
+[the steps][] manually.
### License
-This script is licensed under the GNU General Public License (GPL-3.0). You can find the license text in the LICENSE file.
+This script is licensed under the GNU General Public License (GPL-3.0). You can
+find the license text in the LICENSE file.
+
+[the steps]: https://antennapod.org/documentation/bugs-first-aid/database-error