Update README

zsmb13 · Oct 3, 2023 · df613b2 · df613b2
1 parent 5467f38
commit df613b2
Show file tree

Hide file tree

Showing 9 changed files with 34 additions and 38 deletions.
diff --git a/KotlinLogos/KotlinLogos.xcodeproj/project.pbxproj b/KotlinLogos/KotlinLogos.xcodeproj/project.pbxproj
@@ -71,7 +71,7 @@
  buildConfigurationList = EBBEE0C22ABDC9B80008AEF8 /* Build configuration list for PBXNativeTarget "KotlinLogos" */;
  buildPhases = (
  EBBEE0B42ABDC9B80008AEF8 /* Headers */,
- EBA1F4A62ABE0F1C00BF9DD5 /* Comple Kotlin */,
+ EBA1F4A62ABE0F1C00BF9DD5 /* Compile Kotlin */,
  EBBEE0B52ABDC9B80008AEF8 /* Sources */,
  EBBEE0B62ABDC9B80008AEF8 /* Frameworks */,
  EBBEE0B72ABDC9B80008AEF8 /* Resources */,
@@ -130,7 +130,7 @@
 /* End PBXResourcesBuildPhase section */
 
 /* Begin PBXShellScriptBuildPhase section */
- EBA1F4A62ABE0F1C00BF9DD5 /* Comple Kotlin */ = {
+ EBA1F4A62ABE0F1C00BF9DD5 /* Compile Kotlin */ = {
  isa = PBXShellScriptBuildPhase;
  alwaysOutOfDate = 1;
  buildActionMask = 12;
@@ -140,7 +140,7 @@
  );
  inputPaths = (
  );
- name = "Comple Kotlin";
+ name = "Compile Kotlin";
  outputFileListPaths = (
  );
  outputPaths = (

diff --git a/README.md b/README.md
@@ -4,14 +4,37 @@
 
 ## Installation
 
-### Build the project
+### Use an unsigned release build
+
+Release builds are currently not signed, however you can install an unsigned release build by
+
+1. Download the latest release build from [Releases](https://github.com/zsmb13/KotlinLogo-ScreenSaver/releases).
+2. Unzip the downloaded file.
+3. Open `KotlinLogos.saver`, install it as prompted, this will take you to Screen Saver within System Settings.
+4. When selecting the screen saver, you'll be warned that Apple can not check it for malicious software. Choose "OK", and then select another screen saver to stop the popup from repeatedly showing up.
+
+ ![](/docs/install1.png)
+
+5. Go to Privacy & Security in System Settings, scroll down to Security, and click "Open Anyway" under the message about `KotlinLogos.saver`
+
+ ![](/docs/install2.png)
+
+6. Go back to Screen Saver, select the screensaver again, and choose "Open" which should now be available.
+
+ ![](/docs/install3.png)
+
+7. Enjoy!
+
+### Build it yourself
+
+Build the artifact:
 
 ```
 cd KotlinLogos
-xcodebuild -scheme KotlinLogos build
+xcodebuild -scheme KotlinLogosRelease build
 ```
 
-### Install the screensaver:
+Then, to install it:
 
 1. Locate the output file:
  * Open `KotlinLogos` in XCode, `Product -> Show Build Folder in Finder`, browse to `Products/Debug/KotlinLogos.saver`.
@@ -21,9 +44,12 @@ xcodebuild -scheme KotlinLogos build
  * Opening it to install it in System Settings OR
  * Manually copying it to `~/Library/Screen Savers/`
 
-### Configure parameters
+### Customize parameters
+
+In System Settings -> Screen Saver, select the screen saver, and then choose _Options..._ to customize logo size, count, and speed.
 
-Go to System Settings -> Screen Saver, select the screen saver, and then _Options_ to customize logo size, count, and speed.
+![Use the Options button](/docs/config1.png)
+![Customize parameters](/docs/config2.png)
 
 ### Backlog
 

diff --git a/docs/config1.png b/docs/config1.png
diff --git a/docs/config2.png b/docs/config2.png
diff --git a/docs/install1.png b/docs/install1.png
diff --git a/docs/install2.png b/docs/install2.png
diff --git a/docs/install3.png b/docs/install3.png
diff --git a/src/nativeMain/kotlin/Main.kt b/src/nativeMain/kotlin/Main.kt
@@ -5,7 +5,6 @@ import kotlinx.cinterop.ExperimentalForeignApi
 import kotlinx.cinterop.useContents
 import platform.AppKit.*
 import platform.Foundation.NSBundle
-import platform.Foundation.NSLog
 import platform.Foundation.NSMakeRect
 import platform.Foundation.NSRect
 import platform.ScreenSaver.ScreenSaverView

diff --git a/src/nativeMain/kotlin/Util.kt b/src/nativeMain/kotlin/Util.kt