Skip to content

Commit cf8dd2d

Browse files
committed
Added documentation for compiling this module.
1 parent 1ed4e74 commit cf8dd2d

File tree

2 files changed

+14
-0
lines changed

2 files changed

+14
-0
lines changed

README.md

+7
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,13 @@ Install this module by copying it into your *~/.textadept/modules/* directory or
77

88
require('file_diff')
99

10+
## Compiling
11+
12+
Releases include binaries, so building this modules should not be necessary. If you want to
13+
build manually, run `make deps` followed by `make`. This assumes the module is installed
14+
in Textadept's *modules/* directory. If it is not (e.g. it is in your `_USERHOME`), run
15+
`make ta=/path/to/textadept`.
16+
1017
## Usage
1118

1219
A sample workflow is this:

init.lua

+7
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,13 @@ local M = {}
1111
--
1212
-- require('file_diff')
1313
--
14+
-- ### Compiling
15+
--
16+
-- Releases include binaries, so building this modules should not be necessary. If you want to
17+
-- build manually, run `make deps` followed by `make`. This assumes the module is installed
18+
-- in Textadept's *modules/* directory. If it is not (e.g. it is in your `_USERHOME`), run
19+
-- `make ta=/path/to/textadept`.
20+
--
1421
-- ### Usage
1522
--
1623
-- A sample workflow is this:

0 commit comments

Comments
 (0)