diff options
| -rw-r--r-- | docs/source/user/getting_started_command_line.rst | 16 |
1 files changed, 12 insertions, 4 deletions
diff --git a/docs/source/user/getting_started_command_line.rst b/docs/source/user/getting_started_command_line.rst index 0c4d507..04913d7 100644 --- a/docs/source/user/getting_started_command_line.rst +++ b/docs/source/user/getting_started_command_line.rst @@ -21,9 +21,11 @@ including a ``settings.yaml`` skeleton and it will initialize a git repository (use ``--no-git`` to skip this part and ignore all further git commands). -It will then open ``settings.yaml`` in an editor: fill in your list of -fields and all other data, save and exit. -You are now ready to commit the configuration for your new collection:: +It will then open ``settings.yaml`` in an editor: fill in your values +for the available variables, and define your list of fields; see +:doc:`settings` for details. Then save and exit, and you are now ready to +commit the configuration for your new collection, as the changes have +already been added to git:: git commit -m 'Collection settings' @@ -54,9 +56,15 @@ for your query you can use the option ``--all``. This is especially useful when passing the results to a template:: lesana search --template templates/my_report.html --all \ - some search terms \ + <some search terms> \ > some_search_terms-report.html will generate an html file based on the jinja2 template ``templates/my_report.html`` with all the entries found for those search terms. + +If later on you want to clone the repository elsewhere (using regular +git commands) you can use ``git init`` in the new repository to install +the hooks to manage updating the local cache every time the repository +is updated via git, and then run ``lesana index`` to prepare the first +version of the cache. |