Skip to content

Commit

Permalink
split changelog off the login screen to make the login screen more r…
Browse files Browse the repository at this point in the history
…eadable
  • Loading branch information
obra committed Aug 15, 2024
1 parent 43e023d commit 6247604
Show file tree
Hide file tree
Showing 4 changed files with 55 additions and 48 deletions.
33 changes: 33 additions & 0 deletions changes.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
## Recent updates

- 2024-08-14: Update udev instructions to not require a device replug
- 2024-05-17: Update udev rules to fix a typo.
- 2024-05-15: Clean up our tooltip presentation; improve print styling of layout cards
- 2024-05-14: Fixup our firefox support to at least explain that we don't support firefox.
- 2024-05-13: Update udev rules to match what we do in Kaleidoscope.
- 2024-05-01: Properly handle changing dual-use layers from the layers tab.
- 2024-03-18: Fixed an issue with the ability to edit sticky modifier keys
- 2024-03-15: The default preferences screen is now keyboard settings instead of user interface settings
- 2024-03-14: Honor system dark mode preference
- 2024-03-08: Update to 0.92.6 firmware builds which fix some settings getting set to bad defaults after a factory
restore or EEPROM erase.
- 2024-03-08: Chrysalis now shows shifted keys as the shifted value on the keymap instead of "Shift" and the unshifted
value.
- 2024-03-08: Chrysalis no longer shows the "you're in the bootloader and can't backup the settings" warning during
firmware update unless you were in the bootloader when you first navigated to the screen.
- 2024-03-07: Chrysalis now restores your custom layer names when doing a firmware upgrade
- 2024-03-07: The bugfixes in 0.92.4 turned out to be incomplete. 0.92.5, hopefully, resolves the issue. Please let us
know at [email protected] if you're still having trouble.
- 2024-03-06: Firmware 0.92.3 may have accidentally overwritten some of your settings, like LED brightness or the
"SpaceCadet Shift" configuration. You should install the latest 0.92.4 firmware and may also need to update those
settings in Preferences -> My Device.
- An earlier update had accidentally reversed the display of transparent and blocked keys
- Updated firmware builds to better handle cases of corrupted EEPROM.
- Chrysalis no longer incorrectly states that it could not connect to your keyboard after a firmware update, requiring
another firmware update.
- Chrysalis will now back up your configuration as a download every time you update your firmware
- "Report an issue" now provides system logs for reports

## Detailed changes

You can access Chrysalis' full source code and a detailed changelog on [the project's GitHub Repository](https://github.com/keyboardio/chrysalis).
56 changes: 10 additions & 46 deletions product-status.md
Original file line number Diff line number Diff line change
@@ -1,62 +1,26 @@
# Keyboardio Chrysalis

This is Chrysalis, the graphical configuration tool for Keyboardio's Kaleidoscope-powered keyboards.
This is Chrysalis, the graphical configuration tool for Keyboardio's Model 100, Atreus, and Model 01 keyboards.

## What should work
## Features

- Changing your layout
- Changing your LED configuration
- Changing device settings
- Loading stock firmware
- Custom firmware updates
- Loading stock and custom firmware
- Backup and restore
- Factory reset

## What doesn't work
## Supported Browsers

Chrysalis requires a browser with WebSerial and WebUSB support. This includes Chrome, Edge, Arc, Brave, and other browsers based on Chromium.
Firefox and Safari don't yet implement WebSerial and WebUSB.

## Upcoming features

- Device disconnect detection
- Loading "pre-configured" layouts

## Device support

- Keyboardio Model 100
- Keyboardio Atreus
- Keyboardio Model 01

_Note:_ On macOS, the Atreus and Model 01 may experience unreliable connectivity with firmware versions before 0.92.1

## Browser support

Chrysalis requires a browser with WebSerial support. Right now, this means Chrome, Edge, Arc, Brave, and other browsers based on Chromium. We're hopeful that Firefox and Apple will implement WebSerial and WebUSB, but neither browser maker has yet announced their intention to do so.

## Recent updates
- 2024-08-14: Update udev instructions to not require a device replug
- 2024-05-17: Update udev rules to fix a typo.
- 2024-05-15: Clean up our tooltip presentation; improve print styling of layout cards
- 2024-05-14: Fixup our firefox support to at least explain that we don't support firefox.
- 2024-05-13: Update udev rules to match what we do in Kaleidoscope.
- 2024-05-01: Properly handle changing dual-use layers from the layers tab.
- 2024-03-18: Fixed an issue with the ability to edit sticky modifier keys
- 2024-03-15: The default preferences screen is now keyboard settings instead of user interface settings
- 2024-03-14: Honor system dark mode preference
- 2024-03-08: Update to 0.92.6 firmware builds which fix some settings getting set to bad defaults after a factory
restore or EEPROM erase.
- 2024-03-08: Chrysalis now shows shifted keys as the shifted value on the keymap instead of "Shift" and the unshifted
value.
- 2024-03-08: Chrysalis no longer shows the "you're in the bootloader and can't backup the settings" warning during
firmware update unless you were in the bootloader when you first navigated to the screen.
- 2024-03-07: Chrysalis now restores your custom layer names when doing a firmware upgrade
- 2024-03-07: The bugfixes in 0.92.4 turned out to be incomplete. 0.92.5, hopefully, resolves the issue. Please let us
know at [email protected] if you're still having trouble.
- 2024-03-06: Firmware 0.92.3 may have accidentally overwritten some of your settings, like LED brightness or the
"SpaceCadet Shift" configuration. You should install the latest 0.92.4 firmware and may also need to update those
settings in Preferences -> My Device.
- An earlier update had accidentally reversed the display of transparent and blocked keys
- Updated firmware builds to better handle cases of corrupted EEPROM.
- Chrysalis no longer incorrectly states that it could not connect to your keyboard after a firmware update, requiring
another firmware update.
- Chrysalis will now back up your configuration as a download every time you update your firmware
- "Report an issue" now provides system logs for reports

## Last Updated

2024.0815.1830
4 changes: 2 additions & 2 deletions src/renderer/screens/ChangeLog.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import Card from "@mui/material/Card";
import CardContent from "@mui/material/CardContent";
import Container from "@mui/material/Container";
import { PageTitle } from "@renderer/components/PageTitle";
import { ProductStatus } from "@renderer/screens/KeyboardSelect/ProductStatus";
import { Changes } from "./ChangeLog/Changes";
import React from "react";
import { useTranslation } from "react-i18next";

Expand All @@ -14,7 +14,7 @@ const ChangeLog = () => {
<PageTitle title={t("changelog.title")} />
<Card sx={{ my: 2 }}>
<CardContent sx={{ width: "100%", px: 4 }}>
<ProductStatus />
<Changes />
</CardContent>
</Card>
</Container>
Expand Down
10 changes: 10 additions & 0 deletions src/renderer/screens/ChangeLog/Changes.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
import React from "react";
import Markdown from "react-markdown";

// Import the raw content of the markdown file
import markdownFile from "@root/changes.md";

export const Changes = () => {
// Convert the raw markdown content to HTML
return <Markdown>{markdownFile}</Markdown>;
};

0 comments on commit 6247604

Please sign in to comment.