diff --git a/docs/getting-started/index.html b/docs/getting-started/index.html index f522d5f..2e21b76 100644 --- a/docs/getting-started/index.html +++ b/docs/getting-started/index.html @@ -25,8 +25,29 @@ It is configured and scripted via Lua, so the config file is a Lua file. You can use any pure Lua library to do whatever you want.
Hilbish’s sample configuration is usually located in hilbish.dataDir .. '/.hilbishrc.lua'
.
You can print that path via Lua to see what it is: print(hilbish.dataDir .. '/.hilbishrc.lua')
.
As an example, it will usually will result in /usr/share/hilbish/.hilbishrc.lua
on Linux.
To edit your user configuration, you can copy that file to hilbish.userDir.config .. '/hilbish/init.lua'
,
-which follows XDG on Linux and MacOS, and is located in %APPDATA% on Windows.
As the directory is usually ~/.config
on Linux, you can run this command to copy it:cp /usr/share/hilbish/.hilbishrc.lua ~/.config/hilbish/init.lua
Now you can get to editing it. Since it’s just a Lua file, having basic
-knowledge of Lua would help. All of Lua’s standard libraries and functions
-from Lua 5.4 are available. Hilbish has some custom and modules that are
-available. To see them, you can run the doc
command. This also works as
-general documentation for other things.