H1K0-dev/tanabata
1
1
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: add build guide

Browse Source
This commit is contained in:
Masahiko AMANO 2022-12-27 21:41:55 +03:00
parent 9da4401406
commit e39003f4cc
1 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -34,9 +34,11 @@ Tanabata FM is a file manager for Linux that will let you enjoy the Tanabata fes
## Usage
First of all, compile the source code or just download [this executable file](https://github.com/H1K0/tanabata/releases/download/v0.1.2-dev/tfm). For better experience, move the executable to the `/usr/bin` directory (totally safe unless you have another app named `tfm`) or add the directory with it to `PATH`.
First of all, compile the source code with `./build.sh`. By default, it builds all targets to the `./build/` directory, but you can specify your custom build directory and target with `./build.sh -b <build_dir> -t <target>`. For example, if you want to build just the CLI app to the `./tfm-cli/` directory, run `./build.sh -t tfm -b ./tfm-cli/`.
Then just open the terminal and run `tfm -h`. If you are running it for the first time, run it with `sudo` or manually create the `/etc/tfm` directory and check its permissions. This is the directory where TFM stores its config file. If everything is set up properly, you should get the following.
For better experience, you can move the CLI executable to the `/usr/bin/` directory (totally safe unless you have another app named `tfm`) or add the directory with it to `PATH`.
Then just open the terminal and run `tfm -h`. If you are running it for the first time, run it with `sudo` or manually create the `/etc/tfm/` directory and check its permissions. This is the directory where TFM stores its config file. If everything is set up properly, you should get the following.
```
(C) Masahiko AMANO aka H1K0, 2022—present