Skip to content

Commit

Permalink
Update the README to say that the browser version runs in a browser
Browse files Browse the repository at this point in the history
  • Loading branch information
obra committed Feb 9, 2024
1 parent c5a17d8 commit f7c68c4
Showing 1 changed file with 8 additions and 54 deletions.
62 changes: 8 additions & 54 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,7 @@ Chrysalis
## About

Chrysalis is a graphical configurator for
[Kaleidoscope][kaleidoscope]-powered keyboards. While still under
development, it is already usable for a number of tasks. To try it,
you don't even need to flash `Kaleidoscope` beforehand, Chrysalis
can do that for you, as it ships with reasonable default firmware
for each supported board.
[Kaleidoscope][kaleidoscope]-powered keyboards.

[kaleidoscope]: https://github.com/keyboardio/Kaleidoscope

Expand All @@ -41,57 +37,22 @@ required, just Chrysalis itself.
Chrysalis supports the [Keyboardio Model01][hw:model01], the [Keyboardio
Model100][hw:model100] and the [Keyboardio Atreus][hw:kbio-atreus].

The original [Atreus][hw:atreus], the [ErgoDox EZ][hw:ergodox-ez] (and any other
keyboard wired like it), and the [SOFT/HRUF Splitography][hw:splitography]
keyboards are also supported, as long as they run suitable firmware.

[hw:kbio-atreus]: https://shop.keyboard.io/collections/keyboardio-atreus
[hw:model100]: https://www.indiegogo.com/projects/the-keyboardio-model-100--4/
[hw:model01]: https://shop.keyboard.io/
[hw:ergodox-ez]: https://ergodox-ez.com/
[hw:atreus]: https://atreus.technomancy.us/
[hw:splitography]: https://softhruf.love/collections/writers/products/soft-hruf-erl

## Supported operating systems

Chrysalis is primarily developed under Linux and macOS, but we
target and test on recent releases of Windows as well.

We generally support the most recent long-term-support releases of
Ubuntu and Fedora, as well as the current releases of macOS and
Windows 11. While we expect Chrysalis to work well on other recent
releases of macOS, Windows, and major Linux distributions, our
support resources are pretty limited and we may not be able to chase
down problems that we can't reproduce on a current operating system
release.

The protocol Chrysalis uses to communicate with the keyboard requires USB serial
support, which is known to be problematic on Windows prior to Windows 10.

Some Linux distributions package and build Chrysalis with changes
that cause it not to work correctly. If you're having trouble with
a vendor-packaged Chrysalis, we recommend that you try the latest
release distributed by the project.
## Supported Browsers

## Installation
Chrysalis is a web based application that runs online at [https://chrysalis.keyboard.io][url]

### From installer packages
[url]: https://chrysalis.keyboard.io

Choose whether to install the production release, or a development snapshot from
the links [above](#downloads), and from the release page, select the installer
appropriate for your operating system.

### macOS Homebrew

```
brew update && brew upgrade
brew install --cask chrysalis
```
Your browser needs to support the WebSerial and WebUSB standards. As of this writing, that includes
Chrome, Edge, Arc, Opera, Brave, and other browsers built on the Chromium engine.

## Reporting issues

Chrysalis is alpha quality software. There will be bugs, missing features and
non-obvious things. Reporting any and all of these help us make the software
Reporting bugs and feature requests help us make the software
better, please feel free to [open issues][issues] liberally!

[issues]: https://github.com/keyboardio/Chrysalis/issues
Expand Down Expand Up @@ -121,10 +82,7 @@ build one from scratch, you can do that, and doing so is fully supported!

## Development

To launch the development environment, simply type `yarn && yarn start`. To do a
production build, use `yarn run build:all`, or limit it to a particular OS:
`yarn run build:linux`, `yarn run build:mac` or `yarn run build:win`. See the
`scripts` section of `package.json` for more scripts.
To launch the development environment, simply type `yarn && yarn start`.

### Translations

Expand All @@ -133,7 +91,3 @@ production build, use `yarn run build:all`, or limit it to a particular OS:
We're using [Weblate][weblate] to manage and maintain translations.

[weblate]: https://hosted.weblate.org/engage/chrysalis/

### Debugging

There are sample debugging configurations provided in the `dev/sample` directory. There is also an example launch.json for VSCode under the `.vscode` directory under `dev/sample/.vscode/launch.json`. To debug the main process, you _may_ wish to launch from an IDE (without using the above in a terminal), configurations for VSCode are provided.

0 comments on commit f7c68c4

Please sign in to comment.