diff --git a/README.md b/README.md index 91314dc3bb..481e9f05e4 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ Espruino JavaScript for Microcontrollers | __|___ ___ ___ _ _|_|___ ___ | __|_ -| . | _| | | | | . | |_____|___| _|_| |___|_|_|_|___| - |_| + |_| https://www.espruino.com           [![Join the chat at https://gitter.im/espruino/Espruino](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/espruino/Espruino?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) @@ -16,7 +16,7 @@ About Espruino is a JavaScript interpreter for microcontrollers. It is designed for devices with as little as 128kB Flash and 8kB RAM. -Please support Espruino by [ordering one of our official boards](https://www.espruino.com/Order) or [donating](https://www.espruino.com/Donate) +Please support Espruino by [ordering one of our official boards](https://www.espruino.com/Order) or [donating](https://www.espruino.com/Donate). Documentation @@ -28,7 +28,7 @@ Browse the [Espruino Website](https://www.espruino.com) (try using search in the There's also a [Reference](https://www.espruino.com/Reference) for JavaScript commands as well as [Tutorials](https://www.espruino.com/Tutorials). However the documentation on the Espruino website will match the version [available for download](https://www.espruino.com/Download) but **not** the latest version on GitHub. -Builds for the [Espruino Board](https://www.espruino.com/EspruinoBoard) and [Pico Board](https://www.espruino.com/Pico) (built automatically for each Git commit) are [available from here](https://www.espruino.com/binaries/git) +Builds for the [Espruino Board](https://www.espruino.com/EspruinoBoard) and [Pico Board](https://www.espruino.com/Pico) (built automatically for each Git commit) are [available from here](https://www.espruino.com/binaries/git). Other documentation of use is: @@ -60,13 +60,13 @@ We try and support users of the boards we sell, but if you bought a non-official License ------- -Please see the [LICENSE](LICENSE) file +Please see the [LICENSE](LICENSE) file. Building -------- -Check out [the page on building Espruino](README_Building.md) +Check out [the page on building Espruino](README_Building.md). Testing @@ -82,7 +82,7 @@ The [officially supported boards](https://www.espruino.com/Order) are the best s While Espruino can run on other boards, we make no money from them and so cannot afford to test, fix or support the firmware on them. We're dependent on the community. -You can download binaries from https://www.espruino.com/Download +You can download binaries from https://www.espruino.com/Download. If you are a board manufacturer interested in getting your board officially supported, please [check out this page](https://www.espruino.com/Business). diff --git a/SECURITY.md b/SECURITY.md index 73489cd4af..25649b5f5f 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -2,11 +2,11 @@ ## Supported Versions -We are currently providing software updates for all [official Espruino devices](https://www.espruino.com/Order) +We are currently providing software updates for all [official Espruino devices](https://www.espruino.com/Order). ## Reporting a Vulnerability -To report a vulnerability please just create a [GitHub issue](https://github.com/espruino/Espruino/issues) +To report a vulnerability please just create a [GitHub issue](https://github.com/espruino/Espruino/issues). If you feel the vulnerability is extremely serious and could be exploited if details were published, -please contact us by email at gw@espruino.com +please contact us by email at gw@espruino.com. diff --git a/libs/filesystem/jswrap_file.c b/libs/filesystem/jswrap_file.c index d89a5ab0b2..d4e0841ea7 100755 --- a/libs/filesystem/jswrap_file.c +++ b/libs/filesystem/jswrap_file.c @@ -598,7 +598,7 @@ Pipe this file to a stream (an object with a 'write' method) ], "return" : ["bool","True on success, or false on failure"] } -Change the paramters used for the flash filesystem. +Change the parameters used for the flash filesystem. The default address is the last 1Mb of 4Mb Flash, 0x300000, with total size of 1Mb. Before first use the media needs to be formatted. diff --git a/libs/math/jswrap_math.c b/libs/math/jswrap_math.c index 802f8e96a1..2b597abb78 100644 --- a/libs/math/jswrap_math.c +++ b/libs/math/jswrap_math.c @@ -180,7 +180,7 @@ JsVarFloat jswrap_math_asin(JsVarFloat x) { "name" : "atan", "generate" : "jswrap_math_atan", "params" : [ - ["x","float","The value to get the arc tangent of"] + ["x","float","The value to get the arc tangent of"] ], "return" : ["float","The arc tangent of x, between -PI/2 and PI/2"] }*/ diff --git a/libs/microbit/jswrap_microbit.c b/libs/microbit/jswrap_microbit.c index f5bdd102c4..8dc5710dc6 100644 --- a/libs/microbit/jswrap_microbit.c +++ b/libs/microbit/jswrap_microbit.c @@ -647,7 +647,7 @@ void jswrap_microbit_accelOn() { "generate" : "jswrap_microbit_accelOff", "ifdef" : "MICROBIT2" } -Turn off events from the accelerometer (started with `Microbit.accelOn`) +Turn off events from the accelerometer (started with `Microbit.accelOn`) */ void jswrap_microbit_accelOff() { if (!accel_watch) return; diff --git a/libs/network/cc3000/jswrap_cc3000.c b/libs/network/cc3000/jswrap_cc3000.c index 702f1bfc62..fdcf85648c 100644 --- a/libs/network/cc3000/jswrap_cc3000.c +++ b/libs/network/cc3000/jswrap_cc3000.c @@ -258,7 +258,7 @@ static void _wlan_getIP_set_address(JsVar *options, char *name, unsigned char *p "name" : "setIP", "generate" : "jswrap_wlan_setIP", "params" : [ - ["options","JsVar","Object containing IP address options `{ ip : '1,2,3,4', subnet, gateway, dns }`, or do not supply an object in otder to force DHCP."] + ["options","JsVar","Object containing IP address options `{ ip : '1,2,3,4', subnet, gateway, dns }`, or do not supply an object in otder to force DHCP."] ], "return" : ["bool","True on success"] } diff --git a/targets/esp8266/jswrap_esp8266.c b/targets/esp8266/jswrap_esp8266.c index 02ce89ea97..d0c3b5d54d 100644 --- a/targets/esp8266/jswrap_esp8266.c +++ b/targets/esp8266/jswrap_esp8266.c @@ -72,7 +72,7 @@ void jswrap_ESP8266_reboot() { "generate" : "jswrap_ESP8266_getResetInfo", "return" : ["JsVar","An object with the reset cause information"] } -At boot time the esp8266's firmware captures the cause of the reset/reboot. This function returns this information in an object with the following fields: +At boot time the esp8266's firmware captures the cause of the reset/reboot. This function returns this information in an object with the following fields: * `reason`: "power on", "wdt reset", "exception", "soft wdt", "restart", "deep sleep", or "reset pin" * `exccause`: exception cause @@ -108,7 +108,7 @@ JsVar *jswrap_ESP8266_getResetInfo() { ["enable", "bool", "Enable or disable the debug logging."] ] } -Enable or disable the logging of debug information. A value of `true` enables debug logging while a value of `false` disables debug logging. Debug output is sent to UART1 (gpio2). +Enable or disable the logging of debug information. A value of `true` enables debug logging while a value of `false` disables debug logging. Debug output is sent to UART1 (gpio2). */ void jswrap_ESP8266_logDebug(bool enable) { os_printf("ESP8266.logDebug, enable=%d\n", enable);