annotate misc/README @ 3430:4ba31dd1f0f5

doc: documentation for testing in new `contributing` section
author Goffi <goffi@goffi.org>
date Fri, 27 Nov 2020 16:40:26 +0100
parents 779351da2c13
children 7550ae9cfbac
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
818
c328bcc4db71 jp: zsh completion, first draft (added in a new /misc directory):
Goffi <goffi@goffi.org>
parents:
diff changeset
1 This directory contains files related to SàT but not directly used by it.
c328bcc4db71 jp: zsh completion, first draft (added in a new /misc directory):
Goffi <goffi@goffi.org>
parents:
diff changeset
2
c328bcc4db71 jp: zsh completion, first draft (added in a new /misc directory):
Goffi <goffi@goffi.org>
parents:
diff changeset
3 * file _jp:
c328bcc4db71 jp: zsh completion, first draft (added in a new /misc directory):
Goffi <goffi@goffi.org>
parents:
diff changeset
4 This is the completion file for zsh. To use it, you need to have it in a path accessible in your fpath variable, and to have completion activated. This can be done by the following commands in your .zshrc:
c328bcc4db71 jp: zsh completion, first draft (added in a new /misc directory):
Goffi <goffi@goffi.org>
parents:
diff changeset
5
c328bcc4db71 jp: zsh completion, first draft (added in a new /misc directory):
Goffi <goffi@goffi.org>
parents:
diff changeset
6 ### .zshrc completion ###
c328bcc4db71 jp: zsh completion, first draft (added in a new /misc directory):
Goffi <goffi@goffi.org>
parents:
diff changeset
7 fpath=(/path/to/directory/with/_jp/ $fpath)
c328bcc4db71 jp: zsh completion, first draft (added in a new /misc directory):
Goffi <goffi@goffi.org>
parents:
diff changeset
8 autoload -U compinit
c328bcc4db71 jp: zsh completion, first draft (added in a new /misc directory):
Goffi <goffi@goffi.org>
parents:
diff changeset
9 compinit
c328bcc4db71 jp: zsh completion, first draft (added in a new /misc directory):
Goffi <goffi@goffi.org>
parents:
diff changeset
10 ### end of .zshrc completion ###
c328bcc4db71 jp: zsh completion, first draft (added in a new /misc directory):
Goffi <goffi@goffi.org>
parents:
diff changeset
11
c328bcc4db71 jp: zsh completion, first draft (added in a new /misc directory):
Goffi <goffi@goffi.org>
parents:
diff changeset
12 Then, you should be able to complete a jp command line by pressing [TAB].
1150
beaf8d4475e4 misc (D-Bus, installation): added a .service file for D-Bus auto-launch feature + installation from setup.py (path adaptation now use regex).
Goffi <goffi@goffi.org>
parents: 818
diff changeset
13
2628
779351da2c13 core, frontends: replaced org\.goffi namespaces by org.salutatoi + fixed generation:
Goffi <goffi@goffi.org>
parents: 1150
diff changeset
14 * org.salutatoi.SAT.service:
1150
beaf8d4475e4 misc (D-Bus, installation): added a .service file for D-Bus auto-launch feature + installation from setup.py (path adaptation now use regex).
Goffi <goffi@goffi.org>
parents: 818
diff changeset
15 This file is used by D-Bus to know how to launch the backend, you have to put in in D-Bus services dir (usually /usr/share/dbus-1/services)