docs: updated installation guide
All checks were successful
REUSE Compliance Check / check (push) Successful in 5s
All checks were successful
REUSE Compliance Check / check (push) Successful in 5s
This commit is contained in:
parent
fa58e5b719
commit
e3a0436027
1 changed files with 27 additions and 26 deletions
|
@ -8,7 +8,7 @@ Pre-built binaries will soon be available on the release page on both Codeberg a
|
||||||
|
|
||||||
### Build requirements
|
### Build requirements
|
||||||
|
|
||||||
- **Go:** A minimum version of Go 1.23.0 is required for installing spruce.
|
- **Go:** A minimum version of Go 1.23.0 is required for installing Enbas.
|
||||||
Please go [here](https://go.dev/dl/) to download the latest version.
|
Please go [here](https://go.dev/dl/) to download the latest version.
|
||||||
|
|
||||||
- **Mage (Optional):** The project includes mage targets for building and installing the binary. The main
|
- **Mage (Optional):** The project includes mage targets for building and installing the binary. The main
|
||||||
|
@ -57,46 +57,46 @@ go install ./cmd/enbas
|
||||||
|
|
||||||
Type `enbas` from your terminal to verify that the installation was successful. You should see the help documentation.
|
Type `enbas` from your terminal to verify that the installation was successful. You should see the help documentation.
|
||||||
|
|
||||||
```bash
|
```
|
||||||
$ enbas
|
$ enbas
|
||||||
SUMMARY:
|
SUMMARY:
|
||||||
enbas - A GoToSocial client for the terminal.
|
enbas - A GoToSocial client for the terminal.
|
||||||
|
|
||||||
VERSION:
|
VERSION:
|
||||||
v0.1.0
|
v0.2.0
|
||||||
|
|
||||||
USAGE:
|
USAGE:
|
||||||
enbas [flags]
|
enbas [flags]
|
||||||
enbas [flags] [command]
|
enbas [flags] [command]
|
||||||
|
|
||||||
COMMANDS:
|
COMMANDS:
|
||||||
accept Accept a request (e.g. a follow request)
|
accept Accepts a request (e.g. a follow request)
|
||||||
add Add a resource to another resource
|
add Adds a resource to another resource
|
||||||
block Block a resource (e.g. an account)
|
block Blocks a resource (e.g. an account)
|
||||||
create Create a specific resource
|
create Creates a specific resource
|
||||||
delete Delete a specific resource
|
delete Deletes a specific resource
|
||||||
edit Edit a specific resource
|
edit Edit a specific resource
|
||||||
follow Follow a resource (e.g. an account)
|
follow Follow a resource (e.g. an account)
|
||||||
init Create a new configuration file in the specified configuration directory
|
init Creates a new configuration file in the specified configuration directory
|
||||||
login Login to an account on GoToSocial
|
login Logs into an account on GoToSocial
|
||||||
mute Mute a resource (e.g. an account)
|
mute Mutes a specific resource (e.g. an account)
|
||||||
reject Reject a request (e.g. a follow request)
|
reject Rejects a request (e.g. a follow request)
|
||||||
remove Remove a resource from another resource
|
remove Removes a resource from another resource
|
||||||
show Print details about a specified resource
|
show Shows details about a specified resource
|
||||||
switch Perform a switch operation (e.g. switch logged in accounts)
|
switch Performs a switch operation (e.g. switching between logged in accounts)
|
||||||
unblock Unblock a resource (e.g. an account)
|
unblock Unblocks a resource (e.g. an account)
|
||||||
unfollow Unfollow a resource (e.g. an account)
|
unfollow Unfollows a resource (e.g. an account)
|
||||||
unmute Unmute a resource (e.g. an account)
|
unmute Umutes a specific resource (e.g. an account)
|
||||||
version Print the application's version and build information
|
version Prints the application's version and build information
|
||||||
whoami Print the account that you are currently logged in to
|
whoami Prints the account that you are currently logged into
|
||||||
|
|
||||||
FLAGS:
|
FLAGS:
|
||||||
--help
|
--help
|
||||||
print the help message
|
print the help message
|
||||||
--config-dir
|
--config-dir
|
||||||
Specify your config directory
|
The path to your configuration directory
|
||||||
--no-color
|
--no-color
|
||||||
Disable ANSI colour output when displaying text on screen
|
Set to true to disable ANSI colour output when displaying text on screen
|
||||||
|
|
||||||
Use "enbas [command] --help" for more information about a command.
|
Use "enbas [command] --help" for more information about a command.
|
||||||
```
|
```
|
||||||
|
@ -106,12 +106,13 @@ The build information is correctly displayed if you've downloaded the binary fro
|
||||||
or if you've built it with Mage.
|
or if you've built it with Mage.
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
|
$ enbas version --full
|
||||||
Enbas
|
Enbas
|
||||||
|
|
||||||
Version: v0.1.0
|
Version: v0.2.0
|
||||||
Git commit: c8892a6
|
Git commit: fa58e5b
|
||||||
Go version: go1.22.4
|
Go version: go1.23.0
|
||||||
Build date: 2024-06-28T21:57:37Z
|
Build date: 2024-08-29T07:24:53Z
|
||||||
```
|
```
|
||||||
|
|
||||||
Once you have completed the installation proceed to the [Getting Started guide](./getting_started.md).
|
Once you have completed the installation proceed to the [Getting Started guide](./getting_started.md).
|
||||||
|
|
Loading…
Reference in a new issue