Skip to content

Commit 3e2e0d1

Browse files
committed
improve readme
1 parent 8c764e9 commit 3e2e0d1

File tree

1 file changed

+46
-31
lines changed

1 file changed

+46
-31
lines changed

README.md

Lines changed: 46 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -10,43 +10,58 @@ The keyboard features three simple buttons that input "hello", "world", and "key
1010

1111
These instructions will guide you through forking the project, making it your own, and setting up a development environment for testing and further development.
1212

13+
### Learn with ChatGPT
14+
Use this custom GPT trained on this repo to learn more about the project and how to make your own keyboard!
15+
16+
<a href="https://chat.openai.com/g/g-i1y7EpBXV-helloworldkeyboard">
17+
<img src="./images/logo.png" style="height:30px">Chat with HelloWorldKeyboard GPT
18+
</a>
19+
1320
### Prerequisites
1421

1522
Before you start, ensure you have Android Studio installed, the official IDE for Android app development:
1623

1724
- [Install Android Studio](https://developer.android.com/studio/install)
1825

19-
### Forking and Cloning the Project
20-
21-
1. **Fork the Repository**:
22-
- Visit the original repository at `https://github.com/modularizer/helloworldkeyboard`.
23-
- Click on the `Fork` button at the top right corner of the page to create a copy of the repository in your GitHub account.
24-
25-
2. **Clone Your Fork**:
26-
- After forking, go to your GitHub account where the new repository exists.
27-
- Open the forked repository and click on `Code` to get the clone URL.
28-
- Copy the URL.
29-
30-
3. **Import the Project in Android Studio**:
31-
- Open Android Studio.
32-
- Go to `File` > `New` > `Project from Version Control`.
33-
- In the URL field, paste the URL of your forked repository.
34-
- Choose your preferred directory and click `Clone`.
35-
36-
### Running and Testing the Project
37-
38-
1. **Set Up an Emulator**:
39-
- Go to Tools > Device Manager > Create Device to create a new Virtual Device.
40-
- Choose a device definition and a system image.
41-
42-
2. **Run the App**:
43-
- With the emulator open, run the app from Android Studio.
44-
45-
3. **Enable and Test the Keyboard**:
46-
- In the emulator, navigate to `Settings` (hint: double-tap the top bar, swipe down, find the gear icon)
47-
- In Settings, search `Manage on-screen Keyboards` or navigate to `Settings` > `System` > `Languages & input` > `On-screen keyboard` > `Manage on-screen keyboards`.
48-
- Enable `Hello World Keyboard`.
49-
- Open any text field, and in the bottom right corner of the screen, tap the keyboard icon to switch to your new keyboard.
26+
### Setting Up Your Project from a Public Template
27+
28+
1. **Create Your Own Copy of the Repository**:
29+
- Navigate to the HelloWorldKeyboard project at `https://github.com/modularizer/helloworldkeyboard`.
30+
- Locate the `Use this template` button near the top of the page and click on it to generate a new repository in your GitHub account using HelloWorldKeyboard as a template.
31+
32+
2. **Set Up Your New Repository**:
33+
- Go to your GitHub profile to find the newly created repository.
34+
- Open this repository, and click on `Code` to reveal the clone options.
35+
- Copy the provided URL for cloning.
36+
37+
3. **Import the Project into Android Studio**:
38+
- Launch Android Studio.
39+
- Select `File` > `New` > `Project from Version Control`.
40+
- In the dialog box, enter the URL of your newly created repository in the URL field.
41+
- Choose a local directory where you want the project to be saved and click `Clone`.
42+
43+
### Running and Testing the Project in Android Studio for Beginners
44+
45+
1. **Setting Up an Emulator for Testing**:
46+
- Open Android Studio and navigate to `Tools` > `Device Manager`.
47+
- Click on `Create Device` to set up a new Android Virtual Device (AVD).
48+
- Select a device definition that resembles a common phone (e.g., Pixel 4) and choose a system image (preferably the latest available version of Android).
49+
- Follow the prompts to create the emulator. Once created, it will appear in your list of available devices.
50+
51+
2. **Configuring to Run the HelloWorldKeyboard Service**:
52+
In Android Studio, go to `Run` > `Edit Configurations...` and set the `Launch Options` to `Nothing` and the `Launch` dropdown to `Nothing`.
53+
This is because unlike other apps, there is no "app" to launch for a keyboard, it is simply enabled in the system settings and activated when a text field is selected.
54+
55+
3. **Enabling and Testing the HelloWorldKeyboard**:
56+
- Start your emulator by selecting it in the AVD Manager and clicking on the green play button.
57+
- **NOTE:** Because it is a service, no app will be launched when you run the project. Instead, the keyboard will be enabled in the system settings.
58+
- Once the emulator is running, open the `Settings` app (you can find it by swiping up on the home screen and searching for 'Settings').
59+
- Navigate to `System` > `Languages & input` > `On-screen keyboard` > `Manage on-screen keyboards`.
60+
- Toggle on the `Hello World Keyboard`.
61+
- To test, open any app that allows you to type text. Click on a text field to bring up the keyboard.
62+
- If the default keyboard appears, switch to the HelloWorldKeyboard by tapping on the keyboard icon in the navigation bar and selecting 'Hello World Keyboard'.
63+
64+
**Note:** It's helpful to keep the README open as you go through these steps. If you encounter any difficulties, refer back to the detailed instructions provided.
5065

5166
![Setup Gif](./images/setup.gif)
5267

0 commit comments

Comments
 (0)