Skip to content

Commit 2633fda

Browse files
authored
Update README.md
1 parent 430140e commit 2633fda

File tree

1 file changed

+31
-2
lines changed

1 file changed

+31
-2
lines changed

README.md

Lines changed: 31 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,31 @@
1-
# text-forge-python
2-
Python support for Text Forge code editor
1+
# Text Forge GDScript mode
2+
Python mode for Text Forge code editor
3+
4+
---
5+
6+
Python Mode is a lightweight and functional mode for Text Forge code editor. It **isn't** a part of official Text Forge modes.
7+
8+
## Mode Features
9+
- Updated to [Text Forge Mode API V2.0](https://github.com/text-forge/text-forge/pull/71)
10+
- Outline system with main functions (detects `def` keywords)
11+
- Special code highlighter
12+
- Simple code completion with keywords
13+
- Linter is in progress ⚠️
14+
- Experimental run feature ⚠️
15+
16+
## Setup
17+
Supports Text Forge 0.1-stable and newer versions.
18+
19+
### Method 1: From releases
20+
- Download `python.tfmode` file from releases.
21+
- Open Text Forge and go to Settings > Mode Manager > Import Mode and select kit file.
22+
- Mode kit is ready to use. Please restart editor for safer experience.
23+
24+
### Method 2: From repo
25+
- Download repo as zip and extract it.
26+
- Open editor data folder (use Settings > Open Data Folder)
27+
- Copy `modes/` folder content to data `modes/`.
28+
- Restart editor.
29+
30+
### Development
31+
This project is one of mahan khalili's projects ([@mkh-user](https://github.com/mkh-user)) but all contribution and development process is same as Text Forge project, for more information see [online docs](https://text-forge.github.io/docs).

0 commit comments

Comments
 (0)