Skip to content

Commit 858f0fc

Browse files
committed
update readme
1 parent fb2ef77 commit 858f0fc

File tree

2 files changed

+20
-22
lines changed

2 files changed

+20
-22
lines changed

CONTRIBUTING.md

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
<!-- ## Building the project
2+
3+
Make sure you have `flatpak` and `flatpak-builder` installed. Then run the commands below. Replace `io.github.vhdirk.Terms` with the value you entered during project creation. Please note that these commands are just for demonstration purposes. Normally this would be handled by your IDE, such as GNOME Builder or VS Code with the Flatpak extension.
4+
5+
```
6+
flatpak install org.gnome.Sdk//44 org.freedesktop.Sdk.Extension.rust-stable//22.08 org.gnome.Platform//43
7+
flatpak-builder --user flatpak_app build-aux/io.github.vhdirk.Terms.Devel.yml
8+
```
9+
10+
## Running the project
11+
12+
Once the project is build, run the command below. Replace Replace `io.github.vhdirk.Terms` and `<project_name>` with the values you entered during project creation. Please note that these commands are just for demonstration purposes. Normally this would be handled by your IDE, such as GNOME Builder or VS Code with the Flatpak extension.
13+
14+
```
15+
flatpak-builder --run flatpak_app build-aux/io.github.vhdirk.Terms.Devel.yml <project_name>
16+
``` -->

README.md

+4-22
Original file line numberDiff line numberDiff line change
@@ -12,18 +12,18 @@
1212
<br/>
1313
<a href="https://vhdirk.github.io/terms/">Docs</a> •
1414
<a href="./LICENSE">License</a> •
15-
<!-- <a href="./CONTRIBUTING.md">Contributing</a> -->
15+
<a href="./CONTRIBUTING.md">Contributing</a>
1616
</p>
1717
<p>
1818
</p>
1919

2020
</div>
2121

2222

23-
<!-- <div align="center">
23+
<div align="center">
2424

25-
![Main window](data/resources/screenshots/screenshot1.png "Main window")
26-
</div> -->
25+
![Main window](docs/img/main_window.png "Main window")
26+
</div>
2727

2828
## Goal
2929

@@ -47,24 +47,6 @@ Terms is still very much in development. The following features are present but
4747
- [ ] Store and load session like Tilix and Prompt do
4848
- [ ] tmux Control Mode, based on <https://github.com/gnome-terminator/terminator/pull/408> and <https://github.com/iamjackg/terminator/tree/tmux-v2>
4949

50-
51-
<!-- ## Building the project
52-
53-
Make sure you have `flatpak` and `flatpak-builder` installed. Then run the commands below. Replace `io.github.vhdirk.Terms` with the value you entered during project creation. Please note that these commands are just for demonstration purposes. Normally this would be handled by your IDE, such as GNOME Builder or VS Code with the Flatpak extension.
54-
55-
```
56-
flatpak install org.gnome.Sdk//44 org.freedesktop.Sdk.Extension.rust-stable//22.08 org.gnome.Platform//43
57-
flatpak-builder --user flatpak_app build-aux/io.github.vhdirk.Terms.Devel.yml
58-
```
59-
60-
## Running the project
61-
62-
Once the project is build, run the command below. Replace Replace `io.github.vhdirk.Terms` and `<project_name>` with the values you entered during project creation. Please note that these commands are just for demonstration purposes. Normally this would be handled by your IDE, such as GNOME Builder or VS Code with the Flatpak extension.
63-
64-
```
65-
flatpak-builder --run flatpak_app build-aux/io.github.vhdirk.Terms.Devel.yml <project_name>
66-
``` -->
67-
6850
## Credits
6951

7052
The following projects gave me _lots_ of ideas.

0 commit comments

Comments
 (0)