Skip to content

Commit 148d904

Browse files
Update docs to: #166: Improve installation docs (@mkh-user)
1 parent 55e496a commit 148d904

File tree

1 file changed

+14
-11
lines changed

1 file changed

+14
-11
lines changed

docs/setup.md

Lines changed: 14 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,14 @@
11
# Setup
22

3-
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 extract it where your want!
3+
Text Forge currently supports Linux and Windows. Just download the [latest](https://github.com/text-forge/text-forge/releases/latest)
4+
release and extract it where you want, there is no dependency!
45

56
!!! Note
67

7-
You can see build guide here: [Open Text Forge source in Godot](build.md)
8+
Text Forge currently doesn't support other platforms because of platform-specific limits.
9+
If you want to build editor from source, you can see guide here: [Open Text Forge source in Godot](build.md)
810

9-
Now you can run Text Forge with `Text Forge` runnable file:
11+
Now you can open extracted `Text Forge` directory and run Text Forge with `Text Forge` runnable file:
1012

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

@@ -18,11 +20,11 @@ about modes [here](modes.md), but for now let's get your modes from Text Forge M
1820

1921
You can use **Settings > Marketplace** to find themes, extensions, and modes and install them in one click. For modes, use filter
2022
option in top-right corner of marketplace window and set it from *All* to *Modes*. Now you can see available modes, click on a mode
21-
to see it's details, if it's what you want click on **Install** button and wait until **Package Installed!** notification.
23+
to see its details, if it's what you want click on **Install** button and wait until **Package Installed!** notification.
2224

2325
!!! Tip
2426

25-
You can find about mode installation [here](modes.md#installing).
27+
You can find more about mode installation [here](modes.md#installing).
2628

2729
## Open A File
2830

@@ -63,11 +65,11 @@ In Text Forge:
6365

6466
But why? We have specific reasons for this design:
6567

66-
|Feature |Folder-based projects |`.tfproj` projects |
67-
|-----------------------|-------------------------------|------------------------|
68-
|File Path Flexibility |Only files inside the folder |Any file from any path |
69-
|Single-File Projects |Requires a folder |A single file is enough |
70-
|Custom Project Settings|Scattered across multiple files|Centralized in `.tfproj`|
68+
| Feature | Folder-based projects | `.tfproj` projects |
69+
|-------------------------|---------------------------------|--------------------------|
70+
| File Path Flexibility | Only files inside the folder | Any file from any path |
71+
| Single-File Projects | Requires a folder | A single file is enough |
72+
| Custom Project Settings | Scattered across multiple files | Centralized in `.tfproj` |
7173

7274
Overall, this design gives you more flexibility. You can keep parts of a larger project in different
7375
folders and switch between them in the editor with a single click.
@@ -89,6 +91,7 @@ To automatically save files when moving between project files, enable
8991
**Settings > Preferences... > Files > Save Files When Moving Between Project Files**.
9092

9193
!!! Tip
94+
9295
See also: [Project menu](menus.md#project)
9396

9497
## Customize Editor Appearance
@@ -105,7 +108,7 @@ see where themes are installed use `Settings > Open Data Folder` and go to `them
105108

106109
### UI Filter
107110

108-
Sometimes you need to change editor appearance just to add more brightness or less saturation, in this
111+
Sometimes you need to change editor appearance just to add more brightness or less saturation, in these
109112
situations you can use **UI Filter** a feature to apply customizations in a few moments. To see how
110113
it works, open `Settings > Preferences` and go to `Editor UI` in this section you can find three
111114
options: `Filter Hue Shift`, `Filter Saturation`, and `Filter Brightness`. With this feature you can

0 commit comments

Comments
 (0)