Skip to content

Commit f881cd8

Browse files
committed
Add description of customizable variables.
1 parent 001cc11 commit f881cd8

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

README.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,29 @@ compiler as `go run *.go` so any sources from the snippet directory will be incl
7474
| `go-playground-rm` | Remove the snippet with its directory with all files. |
7575
<!--- END RECEIVE ORGTBL keys -->
7676

77+
### List of customizable variables
78+
79+
<!---
80+
#+ORGTBL: SEND vars orgtbl-to-gfm
81+
| Function name | Description |
82+
|----------------------------------+-------------------------------------------------------------------------------------------------|
83+
| `go-playground-ask-for-filename` | Ask for the snippet filename on a new playground creation. By default it got name `snippet.go`. |
84+
| `go-playground-basedir` | Default directory where snippets dirs will placed. Each new snippet got a new dir under this. |
85+
| | It has sense place the default directory under GOPATH. Var introduced in the release 1.1. |
86+
| `go-playground-confirm-deletion` | Ask for confirmation before snippet deletion. |
87+
| | It may be annoying so you can switch confirmations off. Var introduced in the release 1.2. |
88+
-->
89+
<!--- BEGIN RECEIVE ORGTBL vars -->
90+
| Function name | Description |
91+
|---|---|
92+
| `go-playground-ask-for-filename` | Ask for the snippet filename on a new playground creation. By default it got name `snippet.go`. |
93+
| `go-playground-basedir` | Default directory where snippets dirs will placed. Each new snippet got a new dir under this. |
94+
| | It has sense place the default directory under GOPATH. Var introduced in the release 1.1. |
95+
| `go-playground-confirm-deletion` | Ask for confirmation before snippet deletion. |
96+
| | It may be annoying so you can switch confirmations off. Var introduced in the release 1.2. |
97+
<!--- END RECEIVE ORGTBL vars -->
98+
99+
77100
Example screen after creation of a new snippet:
78101

79102
![screenshot](playground-screenshot.png)

0 commit comments

Comments
 (0)