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

Merge pull request #122 from wpferguson/update_README.md_for_snaps

Browse Source 
Updated README.md to include snap, flatpak, and appimage information
This commit is contained in:
wpferguson
2018-05-20 15:10:32 -04:00
committed by GitHub
parent 2b1af40bd1 f2ac2595f9
commit c0b89e51d7
1 changed files with 16 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
README.md
View File

@@ -81,19 +81,25 @@ 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/
git clone https://github.com/darktable-org/lua-scripts.git lua
`cd ~/.config/darktable`\
`git clone https://github.com/darktable-org/lua-scripts.git lua`
### Windows
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 and run:
cd %LOCALAPPDATA%\darktable
git clone https://github.com/darktable-org/lua-scripts.git lua
Open a command prompt.
`cd %LOCALAPPDATA%\darktable`\
`git clone https://github.com/darktable-org/lua-scripts.git lua`
## Enabling
@@ -101,12 +107,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
@@ -119,13 +125,13 @@ To update the script repository, open a terminal or command prompt and do the fo
### Linux and MacOS
cd ~/.config/darktable/lua
git pull
`cd ~/.config/darktable/lua`\
`git pull`
### Windows
cd %LOCALAPPDATA%\darktable\lua
git pull
`cd %LOCALAPPDATA%\darktable\lua`\
`git pull`
## Documentation