Skip to content

Commit cc1291f

Browse files
v1.0 Production
1 parent 2aff540 commit cc1291f

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

45 files changed

+10523
-850
lines changed

.github/workflows/build-and-release.yml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: Build EXE and Release
1+
name: Build ChiX Editor and Release
22

33
on:
44
push:
@@ -19,7 +19,7 @@ jobs:
1919
- name: Set up Python
2020
uses: actions/setup-python@v4
2121
with:
22-
python-version: '3.13.2'
22+
python-version: '3.11'
2323

2424
- name: Install dependencies
2525
run: |
@@ -29,7 +29,7 @@ jobs:
2929
3030
- name: Build executable with PyInstaller
3131
run: |
32-
pyinstaller app.py --onefile --noconsole --name c_editor
32+
pyinstaller main.py --onefile --noconsole --name ChiX --icon=generated-icon.png
3333
3434
- name: Get short commit hash
3535
id: vars
@@ -42,9 +42,9 @@ jobs:
4242
uses: softprops/action-gh-release@v1
4343
with:
4444
tag_name: "build-${{ env.SHORT_SHA }}"
45-
name: "Build ${{ env.SHORT_SHA }}"
45+
name: "ChiX Editor Build ${{ env.SHORT_SHA }}"
4646
draft: false
4747
prerelease: false
48-
files: dist/c_editor.exe
48+
files: dist/ChiX.exe
4949
env:
50-
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
50+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.gitignore

Lines changed: 15 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -3,35 +3,29 @@ __pycache__/
33
*.py[cod]
44
*$py.class
55

6-
# PyInstaller
7-
# Usually created in dist/ and build/ folders
6+
# Distribution / packaging
87
dist/
98
build/
109
*.spec
1110

12-
# Installer logs
13-
pip-log.txt
14-
pip-delete-this-directory.txt
15-
16-
# Environments
17-
.env
18-
.venv/
11+
# Virtual environments
1912
venv/
20-
ENV/
21-
env.bak/
2213
env/
14+
ENV/
2315

24-
# IDE files
16+
# IDE specific files
2517
.vscode/
2618
.idea/
27-
*.sublime-project
28-
*.sublime-workspace
19+
*.swp
20+
*.swo
2921

30-
# OS generated
31-
.DS_Store
32-
Thumbs.db
33-
desktop.ini
22+
# Local configuration
23+
.env
24+
.replit
25+
.upm/
26+
.pythonlibs/
27+
.cache/
3428

35-
# Temp
36-
*.log
37-
temp/
29+
# OS specific files
30+
.DS_Store
31+
Thumbs.db

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2025 Prakhar Doneria
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

Lines changed: 71 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -1,57 +1,91 @@
1-
# ChiX
1+
# ChiX - Professional VS Code-inspired C Code Editor
22

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+
![ChiX Editor](generated-icon.png)
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.
46

57
## Features
68

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
1117

1218
## Installation
1319

14-
To set up ChiX on your local machine, follow these steps:
20+
### Windows
1521

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.
2123

22-
2. Install the required Python libraries:
23-
```bash
24-
pip install -r requirements.txt
25-
```
24+
### From Source
2625

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
2830

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
3049

31-
1. Run the application:
32-
```bash
33-
python app.py
34-
```
50+
To build the executable yourself:
3551

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+
```
4056

41-
## Code Structure
57+
The executable will be available in the `dist` directory.
4258

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
5078

5179
## Contributing
5280

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.
5486

55-
## Acknowledgments
87+
## Acknowledgements
5688

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

app.py

Lines changed: 0 additions & 57 deletions
This file was deleted.

chix/__init__.py

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
"""
2+
ChiX - Professional VS Code-inspired C Code Editor
3+
Created by Prakhar Doneria
4+
Enhanced by Advanced UI Team
5+
"""
6+
7+
__version__ = "2.0.0"

0 commit comments

Comments
 (0)