Skip to content

Commit

Permalink
[Docs] Download instructions && update install docs
Browse files Browse the repository at this point in the history
  • Loading branch information
qdraw committed Mar 15, 2024
1 parent 683c3d8 commit 1fe92cb
Show file tree
Hide file tree
Showing 14 changed files with 223 additions and 152 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions documentation/docs/developer-guide/api/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,7 @@ This document is auto generated
| __/api/health/details__ | GET | Check if the service has any known errorsFor Authorized Users only |
| __/api/health/version__ | POST | Check if Client/App version has a match with the API-versionthe parameter 've...|
| __/api/health/check-for-updates__ | GET | Check if Client/App version has a match with the API-version |
| __/api/health/release-info__ | GET | Get more info to show about the release |
| __/search__ | POST | Redirect to search GET page (HTML) |
| __/search__ | GET | Search GET page (HTML) |
| __/trash__ | GET | Trash page (HTML) |
Expand Down
55 changes: 51 additions & 4 deletions documentation/docs/getting-started/desktop/desktop-macos.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,57 @@
# Desktop Mac OS

Install on a Macbook or Mac OS
# Do I have Apple Silicon or Intel?

If you're using a Mac and you're not sure whether it's an Intel or Apple Silicon Mac, you can check by clicking on the Apple logo in the top-left corner of your screen, then selecting "About This Mac." In the window that pops up, it will tell you which type of processor your Mac has.
If you bought your Mac recently (after 2020), it's more likely to be an Apple Silicon Mac. If it's an older model, it's probably an Intel Mac.

The difference is:
An Intel Mac is a type of computer made by Apple that uses processors (the brain of the computer) made by Intel, a company that specializes in making computer components. An Apple Silicon Mac is also a computer made by Apple, but it uses processors designed and developed by Apple itself, known as Apple Silicon chips.

# Download page

Click on the Apple Silicon or Intel option:

[![Download options](../../assets/getting-started-desktop-desktop-macos-download-options.jpg)](https://docs.qdraw.nl/download)

Op the dmg file from downloads:

- `starsky-mac-arm64-desktop.dmg` - Apple Silicon Macs
- `starsky-mac-x64-desktop.dmg` - Intel Macs

![Step 1](../../assets/getting-started-desktop-desktop-macos-install-1.jpg)

## Installer step 2

Drag the Starsky App into Applications

![Step 2](../../assets/getting-started-desktop-desktop-macos-install-2.jpg)

## Wait for the installer is done

![Step 3](../../assets/getting-started-desktop-desktop-macos-install-3.jpg)

## Open Terminal

Do code signing yourself or and remove from quarantine with the following command:
````

```
codesign --force --deep -s - /Applications/Starsky.app && xattr -rd com.apple.quarantine /Applications/Starsky.app
````
```

**You need to manually sign the code because we haven't purchased certificates from Apple**

## Installer is done

Click on Applications and open the App there

> Note: Do NOT open the application inside the DMG file this does not work
![Step 4](../../assets/getting-started-desktop-desktop-macos-install-4.jpg)

## It runs

See the [First Steps in the Getting Started Guide](../first-steps.md) for more info on how to setup the storage folder

_To add more instructions on how to_
[![Storage Folder Assets](../../assets/getting-started-first-steps-storage-folder.jpg)](../first-steps.md)
_[Read more in the First Steps](../first-steps.md)_
26 changes: 24 additions & 2 deletions documentation/docs/getting-started/desktop/desktop-windows.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,27 @@
# Windows

Install on Windows
## Installer step 1

_To add more instructions on how to_
Open the downloaded installer: `starsky-win-x64-desktop.exe`

Can you install it globaly or in your own user space. The default option is "Only for me"

![Step 1](../../assets/getting-started-desktop-desktop-windows-install-1.jpg)

## Installer step 2

This is the default location when installing "Only for me"

![Step 2](../../assets/getting-started-desktop-desktop-windows-install-2.jpg)

## Wait for the installer is done

![Step 3](../../assets/getting-started-desktop-desktop-windows-install-3.jpg)

## Installer is done

![Step 4](../../assets/getting-started-desktop-desktop-windows-install-4.jpg)

## It runs

See the [First Steps in the Getting Started Guide](../first-steps.md) for more info on how to setup the storage folder
36 changes: 19 additions & 17 deletions documentation/docs/getting-started/first-steps.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,15 @@ sidebar_position: 3

Welcome to the first steps of your journey with Starsky!

> Note: This guide assumes that you have already download and installed the Application: How to setup the desktop application using [Windows](../getting-started/desktop/desktop-windows.md) and [Mac OS](../getting-started/desktop/desktop-macos.md) you can find in the [Windows Guide](../getting-started/desktop/desktop-windows.md) and [Mac OS Guide](../getting-started/desktop/desktop-macos.md)
## Setting Storage Folder

- Once you have installed Starsky, you can start it by opening the Starsky application.
- Go to Preferences and change the Storage Folder's path to the location where you want to store
your pictures.
- Press Command + Shift + K on Mac OS and Ctrl + Shift + K on Windows to go to Preferences.
- This looks like this:
- Once you have installed Starsky, you can start it by opening the Starsky application.
- Go to Preferences and change the Storage Folder's path to the location where you want to store
your pictures.
- Press Command + Shift + K on Mac OS and Ctrl + Shift + K on Windows to go to Preferences.
- This looks like this:

![Storage Folder Assets](../assets/getting-started-first-steps-storage-folder.jpg)

Expand All @@ -24,26 +26,26 @@ When using as server mode: [see account management for more info](../features/ac

## Run re-sync

- After setting the Storage Folder, you can run a re-sync to update the view with the new location.
- Go to the Home screen
- Press More on the right top
- Click Synchronize manually
- This looks like this:
- After setting the Storage Folder, you can run a re-sync to update the view with the new location.
- Go to the Home screen
- Press More on the right top
- Click Synchronize manually
- This looks like this:

![Manual Sync](../assets/getting-started-first-steps-manual-sync.jpg)

- Press Synchronize current directory manually
- Press Synchronize current directory manually

![Manual Sync](../assets/getting-started-first-steps-manual-sync-2.jpg)

- Wait until the sync is finished
- Wait until the sync is finished

## Importing photos

- After the sync is finished, you can start importing photos.
- Go to the Home screen
- In menu click on Import
- This looks like this:
- After the sync is finished, you can start importing photos.
- Go to the Home screen
- In menu click on Import
- This looks like this:

![Import](../assets/getting-started-first-steps-import.jpg)

Expand All @@ -57,4 +59,4 @@ Read more about [Import here](../features/import.md)

## Search

Learn more about search [Search here](../features/search.md)
Learn more about search [Search here](../features/search.md)
Loading

0 comments on commit 1fe92cb

Please sign in to comment.