Skip to content

Update README.md for linux installation #237

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Serendeep wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update README.md for linux installation #237

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 18 additions & 27 deletions ...y/installation-methods/mac-windows-linux-packages/installing-on-linux/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Any Linux distribution not listed here has not been tested, and the following st
**note:** The application will be extracted into a folder named AppFlowy.

```shell
tar -xzvf AppFlowy-linux-x86.tar.gz
tar -xzvf AppFlowy-*-linux-x86_64.tar.gz
```

3. Go to the AppFlowy directory.
Expand All @@ -35,9 +35,12 @@ cd AppFlowy
4. Run the application.

```shell
./app_flowy
./AppFlowy
```

**NOTE:**
_Please run `sudo chmod a+x /opt/AppFlowy/Appflowy` if the app doesn't launch on first try_

### Emoji Font Installation

AppFlowy will look for the **Noto Color Emoji** font on your system when trying to display emoji unicode characters. Please make sure that the font is configured so that emoji characters are displayed correctly.
Expand Down Expand Up @@ -85,18 +88,14 @@ AppFlowy will look for the **Noto Color Emoji** font on your system when trying

### Optional steps to add AppFlowy to your system menu

{% hint style="danger" %}
The current documentation may be out of sync with the development.
{% endhint %}

Adding an application to Linux's system menu requires some extra steps. In the steps below we assume that you have extracted the archive file contents into the `/opt/` directory and that your present working directory is `/opt/AppFlowy`.

#### Add a Linux desktop file to your system

* Rename the icon file.

```shell
mv flowylogo.svg app_flowy.svg
sudo cp /opt/AppFlowy/data/flutter_assets/assets/images/flowy_logo.svg app_flowy.svg
```

* Copy the icon file so that the system will pick it up.
Expand All @@ -105,28 +104,20 @@ mv flowylogo.svg app_flowy.svg
cp app_flowy.svg ~/.local/share/icons
```

* Copy the temporary desktop file to a usable Linux desktop file. Notice the underscore in `app_flowy`.

```shell
cp appflowy.desktop.temp app_flowy.desktop
```

* Edit the following lines in the `appflowy.desktop` file so that they point to the correct files.
* Create a desktop entry file in `~/.local/share/applications`

```shell
Icon=[CHANGE_THIS]/AppFlowy/flowy_logo.svg
Exec=[CHANGE_THIS]/AppFlowy/app_flowy
[Desktop Entry]
Name=AppFlowy
Comment=An Open Source Alternative to Notion
Icon=~/.local/share/icons/app_flowy.svg
Exec=/opt/AppFlowy/AppFlowy
Categories=Office
Type=Application
Terminal=false
```

For example, if you installed in `/opt`, this becomes:
* Restart after doing the above

```shell
Icon=app_flowy.svg
Exec=/opt/AppFlowy/app_flowy
```

* Move the desktop file so that the system will pick it up.

```shell
mv app_flowy.desktop ~/.local/share/applications
```
**NOTE:**
_Please run `sudo chmod a+x /opt/AppFlowy/Appflowy` if the app doesn't launch on first try_