From d338cd1f97cf9f4b3f9be139d93bd5d0accca9d7 Mon Sep 17 00:00:00 2001 From: Tom Brewe Date: Mon, 24 Jun 2019 22:55:37 +0200 Subject: [PATCH 1/4] Update index.md --- docs/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/index.md b/docs/index.md index d7acdf7..5ce510c 100644 --- a/docs/index.md +++ b/docs/index.md @@ -20,7 +20,7 @@ default: `true`. - `branchSymbols`: A String tuple of the symbols treated as branches. default: `'[]'` -- `ignoredSymbols`: A String of symbols to ignore when performing context sensitive checks. Eg. you may want to define `+-` in two-dimensional turtle-graphic L-Systems to be ignored. default: `''`. +- `ignoredSymbols`: A String of symbols to ignore when performing context sensitive checks. Eg. you may want to define `+-` in two-dimensional turtle-graphic L-Systems to be ignored. default: `+-&^/|\\`. - `forceObjects`: Toggles automatic conversion of Strings into Objects. Eg. axiom 'AB' gets converted to [{symbol: 'A'}, {symbol: 'B'}]. default: `false`. From df36dd88ab069845d618027ecf40321f8cae5444 Mon Sep 17 00:00:00 2001 From: Tom Brewe Date: Mon, 24 Jun 2019 22:56:33 +0200 Subject: [PATCH 2/4] Update index.md --- docs/index.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/index.md b/docs/index.md index 5ce510c..10fd1b7 100644 --- a/docs/index.md +++ b/docs/index.md @@ -20,9 +20,9 @@ default: `true`. - `branchSymbols`: A String tuple of the symbols treated as branches. default: `'[]'` -- `ignoredSymbols`: A String of symbols to ignore when performing context sensitive checks. Eg. you may want to define `+-` in two-dimensional turtle-graphic L-Systems to be ignored. default: `+-&^/|\\`. +- `ignoredSymbols`: A String of symbols to ignore when performing context sensitive checks. Eg. you may want to define `+-` in two-dimensional turtle-graphic L-Systems to be ignored. default: `'+-&^/|\\'`. -- `forceObjects`: Toggles automatic conversion of Strings into Objects. Eg. axiom 'AB' gets converted to [{symbol: 'A'}, {symbol: 'B'}]. default: `false`. +- `forceObjects`: Toggles automatic conversion of Strings into Objects. Eg. axiom `'AB'` gets converted to `[{symbol: 'A'}, {symbol: 'B'}]`. default: `false`. From a5b64242ad2eb7c47cef82529fb44310603d78db Mon Sep 17 00:00:00 2001 From: Tom Brewe Date: Mon, 24 Jun 2019 22:58:13 +0200 Subject: [PATCH 3/4] Update README.md --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index a7e34fe..b29649f 100644 --- a/README.md +++ b/README.md @@ -59,7 +59,8 @@ let kochcurve = new LSystem({ // Iterate the L-System two times and log the result. let result = kochcurve.iterate(2) console.log(result) -//'F-F++F-F-F-F++F-F++F-F++F-F-F-F++F-F++F-F++F-F-F-F++F-F++F-F++F-F-F-F++F-F++F-F++F-F-F-F++F-F++F-F++F-F-F-F++F-F' +//'F-F++F-F-F-F++F-F++F-F++F-F-F-F++F-F++F-F++F-F-F-F++F-F++F +//-F++F-F-F-F++F-F++F-F++F-F-F-F++F-F++F-F++F-F-F-F++F-F' ``` There are multiple ways to set productions, including javascript functions: From b095d44f69284e091548b662dc26f604c841fcb0 Mon Sep 17 00:00:00 2001 From: Tom Brewe Date: Mon, 24 Jun 2019 23:01:31 +0200 Subject: [PATCH 4/4] Update README.md --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index b29649f..423ab65 100644 --- a/README.md +++ b/README.md @@ -104,7 +104,8 @@ lsystem.setProduction('B', (info) => (info.currentAxiom.length / 2) <= info.inde # Documentation -The following section is a quick overview. The full API docs can be found [here](https://github.com/nylki/lindenmayer/blob/master/docs/index.md). +The following section is a quick overview. Please refer to the [full documentation](https://github.com/nylki/lindenmayer/blob/master/docs/index.md) for a detailed usage reference. + ## Initialization ```.js @@ -332,3 +333,5 @@ let parametricLsystem = new lsys.LSystem({ ``` As you can see above, you need to explicitly define the `symbol` value, so the correct production can be applied. + +[Full Documentation](https://github.com/nylki/lindenmayer/blob/master/docs/index.md)