Skip to content
This repository was archived by the owner on Oct 29, 2024. It is now read-only.

Commit 38e2e9e

Browse files
committed
Invert orientation intent
The old method implied that the `h` or `v` represented the direction of the grid. In the months of development for ggn, I've rarely gotten it right the first time, my mental association being that the orientation refers to the guides themselves. Since this seems to be natural, let's use it.
1 parent 2d6e071 commit 38e2e9e

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -20,22 +20,22 @@ e.
2020
- a guide at the top, right, bottom, and left of the document.
2121

2222
```
23-
| ~ | (v)
2423
| ~ | (h)
24+
| ~ | (v)
2525
```
2626

2727

28-
- a three row vertical grid
28+
- a three column vertical grid
2929

3030
```
31-
| ~ | ~ | ~ | ( v )
31+
| ~ | ~ | ~ | ( h )
3232
```
3333

3434

3535
- a one hundred pixel horizontal grid with a ten pixel left margin, ten pixel right margin, and a twenty pixel column centered in the middle
3636

3737
```
38-
| 10px | ~ | 20px | ~ | 10px| ( h, 100px )
38+
| 10px | ~ | 20px | ~ | 10px| ( v, 100px )
3939
```
4040

4141
- a grid with a left side bar with 10px on either side, and a five columns filling the gap.
@@ -164,7 +164,7 @@ A fill is represented by a asterisk `*` folowed by nothing and is a gap that wil
164164

165165
```
166166
$ = 16px |
167-
| $* ( v )
167+
| $* ( h )
168168
```
169169

170170

@@ -174,7 +174,7 @@ Optional values to modify how the grid is created.
174174

175175
### Orientation
176176

177-
Determines the direction the grid will be rendered, whether horizontal or vertical. Orientation options are *not* case sensitve.
177+
Determines the orientation of the guides in the grid. Orientation options are *not* case sensitve.
178178

179179
#### Values:
180180

@@ -222,7 +222,7 @@ Optional unit object that specifies the width of the grid area to be used for th
222222

223223
#### Examples:
224224

225-
- `| ~ | ~ | ~ | ( h, 100px )`
225+
- `| ~ | ~ | ~ | ( v, 100px )`
226226
A three column grid that is one hundred pixels wide.
227227

228228
### Grid offset
@@ -233,16 +233,16 @@ Optional unit object that specifies how far from the origin the grid will be off
233233

234234
- A ten pixel column that sits 50px from the left side of the document/selection
235235

236-
`| 10px | ( hF, , 50px )`
236+
`| 10px | ( vF, , 50px )`
237237

238238

239239
- A ten pixel column that sits 50px from the right site of the doucment/selection
240240

241-
`| 10px | ( hL, , 50px )`
241+
`| 10px | ( vL, , 50px )`
242242

243243
- A ten pixel wide column that sits 30px from the right side of a 100px selection.
244244

245-
`| 10px | ( hL, 100px, 30px)`
245+
`| 10px | ( vL, 100px, 30px)`
246246

247247
## Errors
248248

0 commit comments

Comments
 (0)