Skip to content

Commit 49a7816

Browse files
committed
expand README instructions on installing, running the dev version
1 parent 81729b7 commit 49a7816

File tree

1 file changed

+35
-1
lines changed

1 file changed

+35
-1
lines changed

README.md

+35-1
Original file line numberDiff line numberDiff line change
@@ -304,11 +304,45 @@ on GitHub (link follows below) before submitting a problem report.
304304
[](1}}})
305305
<a name="Stable"></a> []({{{1)
306306
## Stable release
307+
308+
Download the latest released cloc source file, for example `cloc-2.04.pl`, or
309+
the Windows executable `cloc-2.04.exe` from
307310
https://github.com/AlDanial/cloc/releases/latest
308311

309312
<a name="Dev"></a>
310313
## Development version
311-
https://github.com/AlDanial/cloc/raw/master/cloc
314+
315+
Download the cloc source code at https://github.com/AlDanial/cloc/raw/master/cloc and
316+
save it as the file `cloc` (or `cloc.pl`, or whatever executable name you wish).
317+
The next step depends on the operating system you're using.
318+
319+
### On Unix-like systems, including macOS
320+
321+
In a terminal, go to the download directory
322+
and make the cloc file executable, then give it a test run.
323+
For example
324+
325+
```shell
326+
» cd ~/Downloads
327+
» chmod +x cloc
328+
» ./cloc --version
329+
```
330+
331+
For future use, move the file to a more convenient directory in your `PATH`
332+
such as `/usr/local/bin` or `~/bin`.
333+
334+
### On Windows
335+
336+
You'll need a Perl interpreter such as [Strawberry Perl](http://strawberryperl.com/)
337+
installed to run the source version of cloc.
338+
After downloading the cloc source file, open a command prompt or PowerShell window,
339+
navigate to the download directory (`C:\TEMP` in the example below), then test cloc with:
340+
341+
```dos
342+
cd C:\TEMP>
343+
C:TEMP\> perl cloc --version
344+
```
345+
312346
[](1}}})
313347
<a name="License"></a> []({{{1)
314348
# [License &#9650;](#___top "click to go to top of document")

0 commit comments

Comments
 (0)