diff --git a/README.md b/README.md index a7e34fe..423ab65 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: @@ -103,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 @@ -331,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) diff --git a/docs/index.md b/docs/index.md index d7acdf7..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`.