Skip to content

Commit 4d3b2aa

Browse files
committed
Adding important files section to the readme in case somebody else ever needs to work on this repo.
1 parent 0848f9d commit 4d3b2aa

File tree

2 files changed

+12
-2
lines changed

2 files changed

+12
-2
lines changed

Makefile

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
.PHONY: server
22

3-
run:
4-
uv run automator.py
3+
run: server
54

65
deps:
76
uv pip install -r requirements.txt

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -120,3 +120,14 @@ Now you are ready to proceed with the automation setup and run the scripts.
120120
```
121121
122122
This will install the Kindle APK and start the Flask server so it's ready to automate the app.
123+
124+
## Important files
125+
126+
- `server/server.py`: Flask server on port 4098
127+
- `views/state_machine.py`: Handles Kindle app states and transitions
128+
- `views/core/app_state.py`: Kindle views and app states
129+
- `views/transition.py`: Controller between states and handlers
130+
- `views/view_inspector.py`: App view identifying, interacting with appium driver
131+
- `handlers/*_handler.py`: Various handlers for different app states
132+
- `automator.py`: Glue between the Kindle side and the server side, ensuring driver is running
133+
- `driver.py`: Handles Appium driver initialization and management

0 commit comments

Comments
 (0)