|
1 | | -# ChiX |
| 1 | +# ChiX - Professional VS Code-inspired C Code Editor |
2 | 2 |
|
3 | | -ChiX is a Python-based GUI application designed to serve as a C Code Editor and Runner. It provides users with an intuitive interface to write, compile, and run C programs seamlessly. With features like syntax highlighting, file management, and output display, ChiX is ideal for developers and learners working with C. |
| 3 | + |
| 4 | + |
| 5 | +ChiX is a professional-grade C code editor inspired by Visual Studio Code, designed to provide a modern, feature-rich development environment for C programming. |
4 | 6 |
|
5 | 7 | ## Features |
6 | 8 |
|
7 | | -- **C Code Editor**: Write and edit C code with syntax highlighting. |
8 | | -- **C Code Runner**: Compile and run C programs directly from the application. |
9 | | -- **File Management**: Create, open, save, and save-as C files within the application. |
10 | | -- **Themed GUI**: Experience a modern dark-theme user interface. |
| 9 | +- **Modern UI/UX**: Clean, professional interface with intuitive controls |
| 10 | +- **Syntax Highlighting**: Advanced syntax highlighting for C code |
| 11 | +- **Line Numbers**: Clear line numbering with current line highlight |
| 12 | +- **Code Suggestions**: Intelligent code completion and suggestions |
| 13 | +- **Multi-File Editing**: Tabbed interface for working with multiple files |
| 14 | +- **Integrated Compiler**: Compile and run C code directly from the editor |
| 15 | +- **Theming Support**: Light and dark themes with customizable colors |
| 16 | +- **Project Management**: Organize and manage your C projects efficiently |
11 | 17 |
|
12 | 18 | ## Installation |
13 | 19 |
|
14 | | -To set up ChiX on your local machine, follow these steps: |
| 20 | +### Windows |
15 | 21 |
|
16 | | -1. Clone the repository: |
17 | | - ```bash |
18 | | - git clone https://github.com/PrakharDoneria/ChiX.git |
19 | | - cd ChiX |
20 | | - ``` |
| 22 | +Download the latest release from the [Releases](https://github.com/PrakharDoneria/ChiX/releases) page and run the executable. |
21 | 23 |
|
22 | | -2. Install the required Python libraries: |
23 | | - ```bash |
24 | | - pip install -r requirements.txt |
25 | | - ``` |
| 24 | +### From Source |
26 | 25 |
|
27 | | -3. Ensure you have GCC (MinGW) installed and added to your system's PATH. |
| 26 | +```bash |
| 27 | +# Clone the repository |
| 28 | +git clone https://github.com/PrakharDoneria/ChiX.git |
| 29 | +cd ChiX |
28 | 30 |
|
29 | | -## Usage |
| 31 | +# Install dependencies |
| 32 | +pip install -r requirements.txt |
| 33 | + |
| 34 | +# Run the application |
| 35 | +python main.py |
| 36 | +``` |
| 37 | + |
| 38 | +## Requirements |
| 39 | + |
| 40 | +- Python 3.10+ |
| 41 | +- Dependencies: |
| 42 | + - customtkinter |
| 43 | + - pygments |
| 44 | + - keyboard |
| 45 | + - ttkbootstrap |
| 46 | + - pillow |
| 47 | + |
| 48 | +## Building from Source |
30 | 49 |
|
31 | | -1. Run the application: |
32 | | - ```bash |
33 | | - python app.py |
34 | | - ``` |
| 50 | +To build the executable yourself: |
35 | 51 |
|
36 | | -2. Features available: |
37 | | - - Write C code in the editor. |
38 | | - - Use the toolbar to manage files (New, Open, Save, Save As). |
39 | | - - Compile and run your code using the "Compile & Run" button. |
| 52 | +```bash |
| 53 | +pip install pyinstaller |
| 54 | +pyinstaller main.py --onefile --noconsole --name ChiX --icon=generated-icon.png |
| 55 | +``` |
40 | 56 |
|
41 | | -## Code Structure |
| 57 | +The executable will be available in the `dist` directory. |
42 | 58 |
|
43 | | -- **`app.py`**: The main entry point of the application. |
44 | | -- **`core/runner.py`**: Handles code compilation and execution. |
45 | | -- **`utils/highlighter.py`**: Adds syntax highlighting for C code. |
46 | | -- **`compiler/compiler.py`**: Checks GCC installation and compiles C code. |
47 | | -- **`ui/widgets.py`**: Builds the GUI components. |
48 | | -- **`ui/theme.py`**: Configures the application's theme. |
49 | | -- **`core/file_ops.py`**: Manages file operations such as open and save. |
| 59 | +## Usage |
| 60 | + |
| 61 | +1. Launch the application |
| 62 | +2. Create a new file or open an existing one |
| 63 | +3. Write your C code with syntax highlighting and code suggestions |
| 64 | +4. Compile and run your code using the built-in tools |
| 65 | +5. Use keyboard shortcuts for common operations |
| 66 | + |
| 67 | +## Keyboard Shortcuts |
| 68 | + |
| 69 | +- `Ctrl+N`: New file |
| 70 | +- `Ctrl+O`: Open file |
| 71 | +- `Ctrl+S`: Save file |
| 72 | +- `Ctrl+Shift+S`: Save file as |
| 73 | +- `Ctrl+Tab`: Switch between tabs |
| 74 | +- `F5`: Compile and run code |
| 75 | +- `F9`: Toggle theme (Light/Dark) |
| 76 | +- `Ctrl+F`: Find in file |
| 77 | +- `Ctrl+H`: Replace in file |
50 | 78 |
|
51 | 79 | ## Contributing |
52 | 80 |
|
53 | | -Contributions are welcome! Feel free to fork the repository, raise issues, and submit pull requests. |
| 81 | +Contributions are welcome! Please feel free to submit a Pull Request. |
| 82 | + |
| 83 | +## License |
| 84 | + |
| 85 | +This project is licensed under the MIT License - see the LICENSE file for details. |
54 | 86 |
|
55 | | -## Acknowledgments |
| 87 | +## Acknowledgements |
56 | 88 |
|
57 | | -Special thanks to the developers of `customtkinter` and `pygments` for their amazing libraries. |
| 89 | +- Created by Prakhar Doneria |
| 90 | +- Inspired by Visual Studio Code's interface and functionality |
| 91 | +- Built with Python and CustomTkinter |
0 commit comments