This repository was archived by the owner on Aug 5, 2022. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 62
Adding dynamic mode doc and updating ashell doc #1876
Open
brianjjones
wants to merge
2
commits into
intel:master
Choose a base branch
from
brianjjones:dynamic_doc
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,34 @@ | ||
| Dynamic mode - Adds the ability to run JS from the filesystem | ||
| ============================================================ | ||
|
|
||
| * [Introduction](#introduction) | ||
| * [Compilation](#compilation) | ||
| * [How to use](#howtouse) | ||
|
|
||
| Introduction | ||
| ------------ | ||
| Compiling ZJS in dynamic mode gives you the ability to run a JavaScript file from | ||
| the filesystem of the board. Note that running a new JavaScript file will halt | ||
| the current one. Also note that you need to include all the modules you wish to | ||
| use in the original JavaScript file you compile ZJS with. If the JavaScript you | ||
| try to run from the filesystem calls for a module not included in the original | ||
| JavaScript file, it will fail. | ||
|
|
||
| Compilation | ||
| ------------ | ||
| This command will enable dynamic mode: | ||
| ```bash | ||
| $ make dynamic | ||
| ``` | ||
|
|
||
| How to use | ||
| ------- | ||
| Build ZJS with ashell, then copy any JavaScript files you want to run onto the | ||
| filesystem using 'save'. | ||
|
|
||
| In your primary JavaScript file, use 'runJS('filename.js')' whenever you want to load | ||
| a different JavaScript file from the filesystem. Remember your current JavaScript | ||
| will halt once this command is called. You can add this command anywhere you want | ||
| a different JavaScript to load. | ||
|
|
||
| Build ZJS with your primary JavaScript file and reboot. | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Match the equals signs to the text above.
Also, I suggest removing "Adds the ability to" -- titles should be more succinct.