Skip to content

Commit 7437c5d

Browse files
committed
docs: enhance README with comprehensive feature documentation
- Add detailed feature descriptions highlighting core functionality - Include use cases for development, production support, and QA - Streamline content for better readability and scannability - Update GitHub Actions badge from 'style' to 'lint' - Maintain professional presentation with emojis and clear structure
1 parent 059062a commit 7437c5d

1 file changed

Lines changed: 89 additions & 6 deletions

File tree

README.md

Lines changed: 89 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,98 @@
11
# Debugtron
22

3-
[![style](https://github.com/pd4d10/debugtron/workflows/style/badge.svg)](https://github.com/pd4d10/debugtron/actions)
3+
[![lint](https://github.com/pd4d10/debugtron/workflows/lint/badge.svg)](https://github.com/pd4d10/debugtron/actions)
44

5-
Debugtron is an app to debug in-production Electron based app. It is also built with Electron.
5+
Debugtron is a powerful desktop debugging tool for in-production Electron applications. Built with Electron, React, and TypeScript, it provides a comprehensive interface to discover, launch, and debug any Electron app with professional DevTools integration.
66

77
![Screenshot](assets/0.png)
88

9-
## Installation
9+
## ✨ Features
1010

11-
Installation binaries are available at [release page](https://github.com/pd4d10/debugtron/releases).
11+
- **🔍 Automatic App Discovery**: Cross-platform detection of installed Electron applications with visual interface
12+
- **🚀 One-Click Debug Sessions**: Launch any Electron app with debugging flags enabled, support multiple simultaneous sessions
13+
- **🛠️ DevTools Integration**: Access Chrome DevTools for both Node.js main process and renderer processes
14+
- **📊 Real-Time Monitoring**: Live stdout/stderr logging with professional terminal interface
1215

13-
## License
16+
## 🎯 Use Cases
1417

15-
MIT
18+
- **Development & Testing**: Debug production builds, profile performance, and validate features
19+
- **Production Support**: Investigate deployed app issues and reproduce customer problems
20+
- **Quality Assurance**: Test apps without built-in debugging across different platforms
21+
22+
## 📦 Installation
23+
24+
Download the latest release for your platform:
25+
26+
**[📥 Download from GitHub Releases](https://github.com/pd4d10/debugtron/releases)**
27+
28+
### Supported Platforms
29+
30+
- **Windows** (x64)
31+
- **macOS** (Intel & Apple Silicon)
32+
- **Linux** (x64, AppImage)
33+
34+
## 🚀 Quick Start
35+
36+
1. **Launch Debugtron** - Open the application
37+
2. **Select an App** - Choose from automatically discovered Electron applications
38+
3. **Start Debugging** - Click to launch the app with debugging enabled
39+
4. **Open DevTools** - Click "Inspect" buttons to open DevTools for different processes
40+
5. **Monitor Logs** - View real-time application output in the integrated terminal
41+
42+
## 🔧 Development
43+
44+
### Prerequisites
45+
46+
- Node.js 18+
47+
- Yarn package manager
48+
49+
### Setup
50+
51+
```bash
52+
# Clone the repository
53+
git clone https://github.com/pd4d10/debugtron.git
54+
cd debugtron
55+
56+
# Install dependencies
57+
yarn install
58+
59+
# Start development
60+
yarn dev
61+
62+
# Build for production
63+
yarn build
64+
65+
# Package for distribution
66+
yarn package
67+
```
68+
69+
### Project Structure
70+
71+
```
72+
src/
73+
├── main/ # Electron main process
74+
│ ├── actions.ts # Redux thunk actions
75+
│ ├── platforms/ # Platform-specific app discovery
76+
│ └── main.ts # Main entry point
77+
├── renderer/ # React frontend
78+
│ ├── app.tsx # Main app component
79+
│ ├── session.tsx # Debug session interface
80+
│ └── header.tsx # App selection header
81+
├── reducers/ # Redux state management
82+
└── preload.ts # Secure IPC preload script
83+
```
84+
85+
## 🤝 Contributing
86+
87+
Contributions are welcome! Please feel free to submit issues, feature requests, or pull requests.
88+
89+
### Development Guidelines
90+
91+
- Use TypeScript with strict mode
92+
- Follow the existing code style and patterns
93+
- Write clear commit messages
94+
- Test on multiple platforms when possible
95+
96+
## 📄 License
97+
98+
MIT License - see [LICENSE](LICENSE) for details.

0 commit comments

Comments
 (0)