-
Notifications
You must be signed in to change notification settings - Fork 10
Add initial instructions to README #3
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
5 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,52 @@ | ||
 node | ||
====================== | ||
|
||
Implementations of the node.js APIs using wasi for use with AssemblyScript. | ||
Implementations of the node.js APIs for AssemblyScript, utilizing [WASI](https://wasi.dev). | ||
|
||
Introduction | ||
------------ | ||
|
||
This library aims to provide a convenient node.js-like environment for AssemblyScript programs. | ||
Please note that it is still in its early stages and that both the library and WASI are not even | ||
close to be finalized. | ||
|
||
As always, if the idea sounds appealing to you, feel free to improve existing APIs or to contribute | ||
additional ones. | ||
|
||
Instructions | ||
------------ | ||
|
||
Install the library components as a dependency of your project | ||
|
||
``` | ||
$> npm install --save-dev AssemblyScript/node | ||
``` | ||
|
||
and include it in your build step to gain access to the implementations it provides: | ||
|
||
``` | ||
$> asc --lib ./node_modules/@assemblyscript/node/assembly [...] | ||
``` | ||
|
||
Doing so will automatically register common globals like the `Buffer` class and enables requiring | ||
for example the filesystem module through `import * as fs from "fs"`. | ||
|
||
Documentation | ||
------------- | ||
|
||
* [Status and API documentation on the wiki](https://github.com/AssemblyScript/node/wiki) | ||
* [Implementation sources](./assembly) | ||
|
||
Building | ||
-------- | ||
|
||
To run the tests, first make sure that development dependencies are installed, then run: | ||
|
||
``` | ||
$> npm test | ||
``` | ||
|
||
One of the dependencies is [node-wasi](https://github.com/devsnek/node-wasi), which is a native | ||
module. If you are running into issues when compiling it (on Windows), make sure that node-wasi | ||
supports your version of node.js, that your machine can build native modules in the first place | ||
and that your version of npm is recent (`npm install npm@latest -g`). |
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
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.
Uh oh!
There was an error while loading. Please reload this page.