Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #262

Merged
merged 2 commits into from
Dec 8, 2024
Merged

Update README.md #262

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c851ecb
Update README.md
henrikth93 Dec 7, 2024
eb2bdcc
Edits to floating keyboard notes
andrewtavis Dec 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,6 +117,9 @@ git remote add upstream https://github.com/scribe-org/Scribe-Android.git
- Press the play button marked "Run App"
- From here code edits that are made will be reflected in the app each time it is ran

> [!NOTE]
> Currently Scribe-Android does not work as a floating keyboard.

> [!NOTE]
> Feel free to contact the team in the [Android room on Matrix](https://matrix.to/#/#ScribeAndroid:matrix.org) if you're having problems getting your environment setup!

Expand Down
6 changes: 6 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -156,6 +156,9 @@ git remote add upstream https://github.com/scribe-org/Scribe-Android.git
- Press the play button marked "Run App"
- From here code edits that are made will be reflected in the app each time it is ran.

> [!NOTE]
> Currently Scribe-Android does not work as a floating keyboard.

After activating your emulator, consider setting up [pre-commit](https://pre-commit.com/) to fix common errors in the codebase before they're committed by running:

```bash
Expand All @@ -172,6 +175,9 @@ pre-commit install # install pre-commit hooks

# App Setup [`⇧`](#contents)

> [!NOTE]
> Currently Scribe-Android does not work as a floating keyboard.

Users access Scribe language keyboards through the following:

- Open the app and press **`Enable Keyboard`**
Expand Down
Loading