Skip to content

Commit 86a4757

Browse files
authored
Update README.md
1 parent fd3ef2c commit 86a4757

File tree

1 file changed

+111
-1
lines changed

1 file changed

+111
-1
lines changed

README.md

Lines changed: 111 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,113 @@
1-
# V: 2.0.6
1+
# V: Beta
22

33
All "Pull Requests" are accepted.
4+
5+
---
6+
7+
# SystemScript IDE
8+
9+
A professional-grade development environment for the SystemScript programming language.
10+
11+
## Features
12+
13+
- **Modern Code Editor**
14+
- Syntax highlighting for SystemScript
15+
- Line numbering
16+
- Auto-indentation and brace matching
17+
- Multiple tabs for open files
18+
19+
- **Project Management**
20+
- File explorer
21+
- Recent files tracking
22+
- Project organization
23+
24+
- **Build System Integration**
25+
- Compile SystemScript files
26+
- Run and debug applications
27+
- Build output console
28+
29+
- **Professional UI**
30+
- Dark and light themes
31+
- Customizable interface
32+
- Dock-based layout
33+
34+
## Requirements
35+
36+
- Python 3.6+
37+
- PyQt5
38+
- QScintilla (included in PyQt5)
39+
40+
41+
## ssIDE Usage
42+
43+
### Creating a new file
44+
45+
1. Click **File → New** or press **Ctrl+N**
46+
2. Start coding in SystemScript
47+
48+
### Opening an existing file
49+
50+
1. Click **File → Open** or press **Ctrl+O**
51+
2. Browse to your SystemScript file (.ss extension)
52+
3. Select the file and click Open
53+
54+
### Saving files
55+
56+
- To save: Click **File → Save** or press **Ctrl+S**
57+
- To save as a new file: Click **File → Save As** or press **Ctrl+Shift+S**
58+
59+
### Building and running
60+
61+
1. Open a SystemScript file
62+
2. Click **Build → Build** or press **F7** to compile
63+
3. Click **Build → Run** or press **F5** to run the program
64+
4. For a one-step process, use **Build → Build and Run** (Ctrl+F5)
65+
66+
### Switching themes
67+
68+
1. Go to **View → Theme**
69+
2. Select either **Light** or **Dark**
70+
3. Restart the application for the theme to fully apply
71+
72+
## Keyboard Shortcuts
73+
74+
| Action | Shortcut |
75+
|--------|----------|
76+
| New File | Ctrl+N |
77+
| Open File | Ctrl+O |
78+
| Save | Ctrl+S |
79+
| Save As | Ctrl+Shift+S |
80+
| Close Tab | Ctrl+W |
81+
| Exit | Alt+F4 |
82+
| Undo | Ctrl+Z |
83+
| Redo | Ctrl+Y |
84+
| Cut | Ctrl+X |
85+
| Copy | Ctrl+C |
86+
| Paste | Ctrl+V |
87+
| Select All | Ctrl+A |
88+
| Build | F7 |
89+
| Run | F5 |
90+
| Build & Run | Ctrl+F5 |
91+
92+
## Configuration
93+
94+
The IDE settings are stored in `~/.systemscript-ide/config.json`. This file contains your preferences including:
95+
96+
- Window size and position
97+
- Editor settings
98+
- Recent files
99+
- Theme preference
100+
- Compiler settings
101+
102+
## License
103+
104+
This project is licensed under [Creative Commons Attribution-NonCommercial-NoDerivs 4.0 International] – see [CPScript/Legal](https://github.com/CPScript/Legal) for details.
105+
106+
107+
## Contributing
108+
109+
Contributions are welcome! Please feel free to submit a Pull Request.
110+
111+
---
112+
113+
SystemScript IDE © 2025. All rights reserved.

0 commit comments

Comments
 (0)