From befae8b1912f5b1eb5ab037e475e278028c25116 Mon Sep 17 00:00:00 2001 From: supertobi Date: Mon, 9 Apr 2018 11:59:52 +0200 Subject: [PATCH] Improved README.md I've added some information anarcat suggested on pixls.us: https://discuss.pixls.us/t/don-t-forget-the-lua-scripts/1598/8 --- README.md | 28 +++++++++++++++++++++++++++- 1 file changed, 27 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 9968ac6..8161464 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,36 @@ lua-scripts =========== -The Lua scripts in this repository are meant to be used together with darktable. Either copy them individually to `~/.config/darktable/lua` (Linux/Unix) or `%LOCALAPPDATA%\darktable\lua` (Windows) (you might have to create that folder) or just copy/symlink the whole repository there. That allows to update all your scripts with a simple call to `git pull`. +Download +-------- + +The Lua scripts in this repository are meant to be used together with darktable. Either copy them individually to `~/.config/darktable/lua` (Linux/Unix) or `%LOCALAPPDATA%\darktable\lua` (Windows) (you might have to create that folder) or just copy/symlink the whole repository there. + +We recommend to clone the repo straight in or symlink it, because some scripts have dependencies to functions in the `lib` folder. + +To clone the scripts with git, you just need this commands: + +`cd ~/.config/darktable` + +`git clone https://github.com/darktable-org/lua-scripts/` + +That allows to update all your scripts with a simple call to `git pull`. + +Enableling +---------- To enable one of the scripts you have to add a line like `require "examples/hello_world"` to your: `~/.config/darktable/luarc` (Linux/Unix) or `%LOCALAPPDATA%\darktable\luarc` (Windows) file which will enable the example script in `examples/hello_world.lua` (note the lack of the `.lua` suffix). +Alternativ you can add/enabled the scripts in the luarc with this command: + +`echo 'require "examples/hello_world"' >> luarc` + +Documentation +------------- + Each script includes its own documentation and usage in its header, please refer to them. +Contribution +------------ + In order to have your own scripts added here they have to be under a free license (GPL2+ will definitely work, others can be discussed). Scripts in the `official/` subfolder are maintained by the darktable community, those under `contrib/` are meant to have an "owner" who maintains them.