From e39003f4cc78bd13f7241461d49941b7a901dffb Mon Sep 17 00:00:00 2001 From: Masahiko AMANO Date: Tue, 27 Dec 2022 21:41:55 +0300 Subject: [PATCH] docs: add build guide --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 9a09d7c..17a2207 100644 --- a/README.md +++ b/README.md @@ -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 -t `. 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