Skip to content

Commit

Permalink
Add info about keyboard shortcuts to README
Browse files Browse the repository at this point in the history
  • Loading branch information
eurunuela committed May 27, 2022
1 parent 25a96be commit 0a56783
Showing 1 changed file with 12 additions and 4 deletions.
16 changes: 12 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,18 @@ As part of the ME-ICA pipeline, `Rica` (Reports for ICA) provides a reporting to

`Rica` originally came out as an alternative to the reports provided by [tedana](https://github.com/ME-ICA/tedana), with the aim of making manual classification of ICA components possible. At the same time, the tool aspires to be of value for ICA decompositions made with tools other than `tedana`. `Rica` assumes you're working with files that mimic the outputs of `tedana`.

## How to use Rica

Even if Rica is designed to be simple to use, you might want to see how you can use the app by watching this [tutorial video](https://www.loom.com/share/ad37cf6f3c2d41e48721f62168a8284e).

Rica also supports keyboard shortcuts on the ICA components page. You can use the following shortcuts:

- `a`: Accept component.
- `r`: Reject component.
- `i`: Ignore component.
- `left arrow`: Go to previous component.
- `right arrow`: Go to next component.

## Using Rica online

Just head over to https://rica-fmri.netlify.app and have fun!
Expand Down Expand Up @@ -41,10 +53,6 @@ open build/rica.html

> Pro tip: when you open rica.html for the first time, BOOKMARK IT 😉
## Using Rica

Even if Rica is designed to be simple to use, you might want to see how you can use the app by watching this [tutorial video](https://www.loom.com/share/ad37cf6f3c2d41e48721f62168a8284e).

## Getting involved

Want to learn more about our plans for developing `Rica`? Have a question, comment, or suggestion? Open or comment on one of our issues!

0 comments on commit 0a56783

Please sign in to comment.