Skip to content

Commit

Permalink
adapt readme for Microsoft Store, bump version
Browse files Browse the repository at this point in the history
  • Loading branch information
stephtr committed Apr 21, 2020
1 parent f281b1f commit 4565af0
Show file tree
Hide file tree
Showing 6 changed files with 11 additions and 10 deletions.
2 changes: 1 addition & 1 deletion BrightnessSwitch/BrightnessSwitch.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<Nullable>enable</Nullable>
<UseWindowsForms>true</UseWindowsForms>
<ApplicationIcon>sun.ico</ApplicationIcon>
<Version>1.1.0</Version>
<Version>1.1.1</Version>
<RuntimeIdentifiers>win-x86;win-x64</RuntimeIdentifiers>
<Configurations>Debug;Release;Store</Configurations>
<Platforms>AnyCPU;x64;x86</Platforms>
Expand Down
3 changes: 2 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
# Changelog

## unreleased
## 1.1.1

- Fix bug on devices without light sensor
- Optimized machine learning model
- First release in the [Microsoft Store](https://www.microsoft.com/store/productId/9NK5PND0SQ07)

## 1.1.0

Expand Down
15 changes: 7 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
# BrightnessSwitch

[![Total downloads](https://img.shields.io/github/downloads/stephtr/BrightnessSwitch/total.svg)](https://github.com/stephtr/BrightnessSwitch/releases) _- hopefully increasing soon 😉_
[<img src="images/microsoft_store_badge.svg" alt="Get it from Microsoft" width="150" />](https://www.microsoft.com/store/productId/9NK5PND0SQ07)

_Do you have a notebook with Fn and function keys combined and have issues with combinations like <kbd>Alt</kbd>+<kbd>F4</kbd>? Make sure to check out [FixSurfaceKeyboard](https://github.com/stephtr/FixSurfaceKeyboard)._
_Do you have a notebook with Fn and function keys combined and have issues with combinations like <kbd>Alt</kbd>+<kbd>F4</kbd>? Make sure to also check out [FixSurfaceKeyboard](https://github.com/stephtr/FixSurfaceKeyboard)._

---

This small app automatically switches between Windows' Light- and Dark-Theme, depending on the ambient brightness, detected via your device's light sensor.

![Screenshot](screenshot.png)<br />
![Screenshot](images/screenshot.png)<br />
_Screenshot of the app_

In order to control the switching mechanism, it adds a tray icon where one can enable or disable automatic switching of themes, but also an option to manually switch the theme.
Expand All @@ -17,15 +17,14 @@ If automatic switching is enabled and one switches the theme, machine learning (

## Download

- [Microsoft Store](https://www.microsoft.com/store/productId/9NK5PND0SQ07)
- .zip package: [Latest release](https://github.com/stephtr/BrightnessSwitch/releases)
- Installer: coming soon...
- Microsoft Store: under consideration

## Running the app

The app is written in C# (.NET 5.0) and therefore needs the [Desktop Runtime 5.0](https://dotnet.microsoft.com/download/dotnet/5.0#runtime-desktop-5.0.0-preview.2) to be installed.
The easiest and recommended way is to use the [Microsoft Store](https://www.microsoft.com/store/productId/9NK5PND0SQ07) version. If you prefer to manually run the app, follow these instructions:

For this app there is currently no installer available, therefore just download the [latest release](https://github.com/stephtr/BrightnessSwitch/releases) and extract it to a folder of your choice. Then run `BrightnessControl.exe`, autostart with Windows can be enabled via the context menu.
Download the [latest release](https://github.com/stephtr/BrightnessSwitch/releases) and extract it to a folder of your choice. The app is written in C# (.NET 5.0) and therefore needs the [Desktop Runtime 5.0](https://dotnet.microsoft.com/download/dotnet/5.0#runtime-desktop-5.0.0-preview.2) to be installed. Then run `BrightnessControl.exe`, autostart with Windows can be enabled via the context menu.

## Privacy

Expand All @@ -39,7 +38,7 @@ After cloning or downloading the source, running `dotnet run` is sufficient for

Included with the source is also a small Python script for analysing the app's SVM configuration. By running `analysis.py`, it shows a plot containing all your recent manual interventions as dots. The vertical line corresponds to the criteria for switching between light and dark theme with the shaded area being a measure for the uncertainty.

![Screenshot analysis](screenshot_analysis.png)<br />
![Screenshot analysis](images/screenshot_analysis.png)<br />
_Screenshot of the analysis tool_

## Changelog
Expand Down
1 change: 1 addition & 0 deletions images/microsoft_store_badge.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes
File renamed without changes

0 comments on commit 4565af0

Please sign in to comment.