Skip to content

Commit 7a0ff8d

Browse files
committed
Adapt Readme
Remove flatpak
1 parent d0a7bb3 commit 7a0ff8d

File tree

3 files changed

+28
-57
lines changed

3 files changed

+28
-57
lines changed

README.md

Lines changed: 28 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -13,22 +13,35 @@ apply them to the input given on STDIN.
1313
How to Install
1414
==============
1515

16-
The easiest way to run `strans` is by installing it via flatpak. It
17-
assumes that you have the
16+
`strans` is distributed as an AppImage for Linux and as a DMG for MacOs.
17+
Download the latest `strans` from
18+
[releases](https://github.com/Inventitech/strans/releases).
1819

19-
`flatpak install flathub org.freedesktop.Platform//18.08 org.freedesktop.Sdk//18.08`
20+
## Linux
21+
Our AppImage should run on practically any recent linux Desktop distribution.
2022

21-
runtime installed on your system.
23+
After downloading, simply do
2224

23-
After downloading the latest `strans.flatpak` from
24-
[releases](https://github.com/Inventitech/strans/releases), install it
25-
via
25+
`
26+
chmod +x strans-linux.AppImage
27+
./strans-linux.AppImage
28+
`
2629

27-
`sudo flatpak install strans.flatpak`
30+
To install it system-wide as `strans`, just
2831

29-
> Note: This standalone Flatpak package will not auto-update.
32+
`sudo cp strans-linux.AppImage /usr/bin/strans`
3033

31-
How to Run
34+
## MacOs
35+
After mounting the dmg and copying `strans.app` into /Applications, it might be necessary to
36+
37+
```
38+
chmod +x /Applications/strans.app/Contents/MacOS/strans
39+
/Applications/strans.app/Contents/MacOS/strans
40+
```
41+
to run `strans`.
42+
43+
44+
How to Use
3245
==========
3346
```
3447
# With before and after example
@@ -77,7 +90,7 @@ without StackOverflow and Perl, but instead with pure joy!
7790

7891
```
7992
printf "Moritz Beller\nGeorgios Gousios" |
80-
dotnet strans.dll -b "First Last" -a "FL"
93+
strans -b "First Last" -a "FL"
8194
```
8295

8396
neatly outputs
@@ -109,7 +122,7 @@ and call
109122

110123
```
111124
printf "Moritz Beller\nGeorgios Gousios\nAndy Emil Zaidman" |
112-
dotnet strans.dll --example-file example-transformations
125+
strans --example-file example-transformations
113126
```
114127

115128
And, voila, the output is
@@ -125,8 +138,8 @@ transformation rule that satisfies all examples given to it. Simply
125138
having the last FML example would not be enough, because it would miss
126139
the case where only two names are available.
127140

128-
How to Build for Developing
129-
===========================
141+
How to Develop
142+
==============
130143

131144
You need [dotnet](https://dotnet.microsoft.com/) to run `strans`.
132145

@@ -137,7 +150,7 @@ dotnet restore
137150
dotnet publish -c Release
138151
```
139152

140-
An alias (in your bashrc, ...) makes `strans` integrate seamlessly in
153+
An alias (in your bashrc, ...) can make `strans` integrate seamlessly in
141154
a Unix environment:
142155

143156
```

com.inventitech.strans.appdata.xml

Lines changed: 0 additions & 20 deletions
This file was deleted.

com.inventitech.strans.json

Lines changed: 0 additions & 22 deletions
This file was deleted.

0 commit comments

Comments
 (0)