[Pkg-javascript-commits] [leaflet-markercluster] 81/128: Add install and build steps with jake (#733)
Jonas Smedegaard
dr at jones.dk
Sun Apr 16 06:26:06 UTC 2017
This is an automated email from the git hooks/post-receive script.
js pushed a commit to branch master
in repository leaflet-markercluster.
commit 29972bef5830e773871a5ad66a53a6a23c0593d3
Author: Florian Boudot <florian.boudot at gmail.com>
Date: Thu Oct 27 15:49:13 2016 +0200
Add install and build steps with jake (#733)
* Add install and build steps with jake
Hi ! Since I went into this case #732 here is a PR to add explanations about installing jake and building the scripts, and then get this file `leaflet.markercluster-src.js`
* Formatting
---
README.md | 10 +++++++++-
1 file changed, 9 insertions(+), 1 deletion(-)
diff --git a/README.md b/README.md
index 8b9f33f..61d5bfc 100644
--- a/README.md
+++ b/README.md
@@ -17,6 +17,8 @@ removed link to h1 and indented back 2 spaces all links.
## Table of Contents
* [Using the plugin](#using-the-plugin)
* [Usage](#usage)
+ * [Building, testing and linting scripts](#building-testing-and-linting-scripts)
+ * [Examples](#examples)
* [Options](#options)
* [Defaults](#defaults)
* [Customising the Clustered Markers](#customising-the-clustered-markers)
@@ -43,9 +45,15 @@ removed link to h1 and indented back 2 spaces all links.
## Using the plugin
-
Install with npm: `npm install leaflet.markercluster`
+### Building, testing and linting scripts
+Install jake `npm install -g jake` then run `npm install`
+* To check the code for errors and build Leaflet from source, run `jake`.
+* To run the tests, run `jake test`.
+* For a custom build, open `build/build.html` in the browser and follow the instructions
+
+### Examples
See the included examples for usage.
The [realworld example](http://leaflet.github.io/Leaflet.markercluster/example/marker-clustering-realworld.388.html) is a good place to start, it uses all of the defaults of the clusterer.
--
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-javascript/leaflet-markercluster.git
More information about the Pkg-javascript-commits
mailing list