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

Improved README.md

Browse Source 
I've added some information anarcat suggested on pixls.us:
https://discuss.pixls.us/t/don-t-forget-the-lua-scripts/1598/8
This commit is contained in:
supertobi
2018-04-09 11:59:52 +02:00
committed by GitHub
parent 1767e8f074
commit befae8b191
1 changed files with 27 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
README.md
View File

@@ -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.