Skip to content

Commit

Permalink
[#298] Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
SRichner committed Mar 18, 2024
1 parent 1877dc5 commit 445d07b
Show file tree
Hide file tree
Showing 2 changed files with 43 additions and 39 deletions.
41 changes: 2 additions & 39 deletions documentation/INSTALLATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,8 @@ The following video shows the steps in action:

[![How to install PersonalAnalytics on macOS](https://markdown-videos-api.jorgenkh.no/youtube/ovfRzp3Ksgk)](https://youtu.be/ovfRzp3Ksgk)

> If you want to completely remove or reinstall PersonalAnalytics on macOS, please visit the [Troubleshooting](TROUBLESHOOTING.md) page and follow the steps under "macOS: Reinstalling PersonalAnalytics from Scratch".

## Using PersonalAnalytics
For the majority of the time, PersonalAnalytics is running nonintrusively in the background.
Expand All @@ -52,45 +54,6 @@ The researchers might ask you to share the collected data with them for data ana

<img width="641" alt="image" src="https://github.com/HASEL-UZH/PersonalAnalytics/assets/5212692/11c37ff9-a85b-4c45-adbf-2028cfe46a39">

### macOS: Reinstalling PersonalAnalytics from Scratch

1. Quit PA and check it is not running with
```
ps aux | grep -i personal
```
There should only be one result, which is the search command itself

2. Remove permissions for PA in System Preferences:
```
open "x-apple.systempreferences:com.apple.preference.security”
```

Check for entries in “Accessibility” and “Screen & System Audio Recording”, and delete these entries using the “-“ symbol at the bottom of the list.

> Note: Checking for these permissions needs to be done *BEFORE* deleting the PA app, as permissions for deleted apps are kept, but not shown in this list if the app is deleted.
3. Delete PA and its settings

- Copy the database if you want to keep it
```
open ~/Library/Application\ Support/personal-analytics
```
- Delete PA
```
rm -rf /Applications/PersonalAnalytics.app
```
- Delete Settings
```
rm -rf ~/Library/Application\ Support/personal-analytics
```

4. Make sure PA and settings are deleted
```
ls -lah /Applications | grep -i personal
ls -lah ~/Library/Application\ Support | grep -i personal
```

5. Done - you can freshly install PersonalAnalytics now!

### Questions
In case of questions, contact the researchers who asked you to install PersonalAnalytics. You find their email in the study description or by clicking "Get Help" in the context menu.
41 changes: 41 additions & 0 deletions documentation/TROUBLESHOOTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# Troubleshooting PersonalAnalytics

### macOS: Reinstalling PersonalAnalytics from Scratch
> If you are experiencing issues with PersonalAnalytics on macOS and want to reinstall the app, please follow the steps below:
1. Quit PA and check that it is not running with:
```
ps aux | grep -i personal
```

2. Remove permissions for PA in System Settings:
```
open "x-apple.systempreferences:com.apple.preference.security”
```

Check for entries in “Accessibility” and “Screen & System Audio Recording”, and delete these entries using the “-“ symbol at the bottom of the list.

> Note: Checking for these permissions needs to be done *BEFORE* deleting the PA app, as permissions for deleted apps are kept, but not shown in this list if the app is deleted.
3. Delete PA and its settings

- Copy the database if you want to keep it
```
open ~/Library/Application\ Support/personal-analytics
```
- Delete PA
```
rm -rf /Applications/PersonalAnalytics.app
```
- Delete Settings
```
rm -rf ~/Library/Application\ Support/personal-analytics
```

4. Make sure PA and settings are deleted
```
ls -lah /Applications | grep -i personal
ls -lah ~/Library/Application\ Support | grep -i personal
```

5. Done - you can freshly install PersonalAnalytics now!

0 comments on commit 445d07b

Please sign in to comment.