Skip to content

Commit 729846b

Browse files
committed
Update docs
1 parent 895afab commit 729846b

3 files changed

Lines changed: 41 additions & 9 deletions

File tree

docs/build.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Build Text Forge from source
2+
3+
!!! note
4+
5+
This page currently haven't guide for build, there is just manual for open project source in Godot.
6+
7+
## Get Engine
8+
9+
Text Forge built on Godot (v4.4.1.stable.official [49a5bc7b6]), you can get this version from this page:
10+
11+
https://godotengine.org/download/archive/4.4.1-stable
12+
13+
## Get Source
14+
15+
To get source you can use `git clone` or with GitHub Desktop:
16+
```
17+
git clone https://github.com/text-forge/text-forge.git
18+
```
19+
Or open [official repo](https://github.com/text-forge/text-forge) and click on `Code > Open with GitHub Desktop` and configure it.
20+
21+
## Edit Project
22+
23+
Now you can use Godot to import project and edit it, or press `F5` to run project.
24+
25+
!!! important
26+
27+
If your clone is for conribution, Alway create a new branch for new PRs.

docs/introduction.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,16 @@
33
Welcome to Text Forge!
44

55
Text Forge is an open source code editor based on:
6-
- lightweight design
7-
- extensibility
8-
- mode-drive design
9-
- be customizable
10-
- scriptable design
11-
- language agnostic design
12-
- data-driven interface
13-
- object-oriented design
14-
- plug-and-play extension architecture
6+
7+
* lightweight design
8+
* extensibility
9+
* mode-drive design
10+
* be customizable
11+
* scriptable design
12+
* language agnostic design
13+
* data-driven interface
14+
* object-oriented design
15+
* plug-and-play extension architecture
1516

1617
![Simple screenshot](https://text-forge.github.io/docs/img/introduction_screenshot.png)
1718

docs/setup.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22

33
Text Forge currently supports Linux and Windows (You can use it on other platforms with build it from source), Just download [latest](https://github.com/text-forge/text-forge/releases/latest) and install it! (or download portable version and extract it anywhere you want)
44

5+
!!! note
6+
7+
You can see build guide here: [Open Text Forge source in Godot](build.md)
8+
59
Now you can run Text Forge:
610

711
![image.png](https://text-forge.github.io/docs/img/setup_screenshot.png)

0 commit comments

Comments
 (0)