darktable/lua-scripts-w-api
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Updated README.md to include snap, flatpak, and appimage information

Browse Source
This commit is contained in:
Bill Ferguson
2018-05-20 15:02:37 -04:00
parent 66f85a1f35
commit b241007d4f
1 changed files with 10 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@@ -81,11 +81,15 @@ get_libdoc|No|LMW|Retrieve the library documentation and output it as text
The recommended method of installation is using git to clone the repository. This ensures that all dependencies on other scripts
are met as well as providing an easy update path. Single scripts listed as standalone may be downloaded and installed by themselves.
### snap, flatpak, and appimage packages
These packages run in their own environment and don't have access to a lua interpreter, therefore the scripts can't run. The packagers could enable the internal interpreter, or allow the package to link the interpreter from the operating system, or bundle a copy of lua with the package. If you use one of these packages and wish to use the lua scripts, please contact the package maintainer and suggest the above fixes.
### Linux and MacOS
Ensure git is installed on your system. If it isn't, use the package manager to install it. Then:
`cd ~/.config/darktable`
`cd ~/.config/darktable`\
`git clone https://github.com/darktable-org/lua-scripts.git lua`
### Windows
@@ -93,7 +97,7 @@ Ensure git is installed on your system. If it isn't, use the package manager to
Ensure git is installed on your system. Git can be obtained from https://gitforwindows.org, as well as other places. If you use the gitforwindows.org distribution, install the Git Bash Shell also as it will aid in debugging the scripts if necessary. Then:
Open a command prompt.
`cd %LOCALAPPDATA%\darktable`
`cd %LOCALAPPDATA%\darktable`\
`git clone https://github.com/darktable-org/lua-scripts.git lua`
## Enabling
@@ -102,12 +106,12 @@ When darktable starts it looks for a file name `~/.config/darktable/luarc` (`%LO
You can also create or add lines to the luarc file from the command line:
`echo 'require "contrib/gimp"' > ~/.config/darktable/luarc` to create the file with a gimp entry
`echo 'require "contrib/gimp"' > ~/.config/darktable/luarc` to create the file with a gimp entry\
or `echo 'require "contrib/hugin"' >> ~/.config/darktable/luarc` to add an entry for hugin.
On windows from a command prompt:
`echo 'require "contrib/gimp"' > %LOCALAPPDATA%\darktable\luarc` to create the file with a gimp entry
`echo 'require "contrib/gimp"' > %LOCALAPPDATA%\darktable\luarc` to create the file with a gimp entry\
or `echo 'require "contrib/hugin"' >> %LOCALAPPDATA%\darktable\luarc` to add an entry for hugin.
## Disabling
@@ -120,12 +124,12 @@ To update the script repository, open a terminal or command prompt and do the fo
### Linux and MacOS
`cd ~/.config/darktable/lua`
`cd ~/.config/darktable/lua`\
`git pull`
### Windows
`cd %LOCALAPPDATA%\darktable\lua`
`cd %LOCALAPPDATA%\darktable\lua`\
`git pull`
## Documentation