Skip to content

Commit b1e4c7d

Browse files
authored
Update README.md
1 parent 2bf7716 commit b1e4c7d

File tree

1 file changed

+28
-2
lines changed

1 file changed

+28
-2
lines changed

README.md

Lines changed: 28 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,28 @@
1-
# rust-mode
2-
Rust support for Text Forge code editor
1+
# Text Forge Rust mode
2+
Official Rust mode for Text Forge code editor
3+
4+
---
5+
6+
Rust Mode is a lightweight and functional mode for Text Forge code editor. It's 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+
- Edit Rust files in Text Forge's feature rich editing enviroment
11+
- Simple code highlighter
12+
13+
## Setup
14+
Supports Text Forge 0.1-stable and newer versions.
15+
16+
### Method 1: From releases
17+
- Download `rust.tfmode` file from releases.
18+
- Open Text Forge and go to Settings > Mode Manager > Import Mode and select mode file.
19+
- Mode is ready to use. If you are updating, please restart the editor for a safer experience.
20+
21+
### Method 2: From repo
22+
- Download repo as zip and extract it.
23+
- Open editor data folder (use Settings > Open Data Folder)
24+
- Copy `modes/` folder content to data `modes/`.
25+
- Restart editor.
26+
27+
### Development
28+
This project is under Text Forge organization and MIT license, so 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)