|
1 | 1 |  AssemblyScript
|
2 | 2 | =================
|
3 | 3 |
|
4 |
| -[](https://github.com/AssemblyScript/assemblyscript/actions) |
| 4 | +[](https://github.com/AssemblyScript/assemblyscript/actions) [](https://www.npmjs.com/package/assemblyscript) [](https://www.npmjs.com/package/assemblyscript) |
5 | 5 |
|
6 | 6 | **AssemblyScript** compiles a strict subset of [TypeScript](http://www.typescriptlang.org) (basically JavaScript with types) to [WebAssembly](http://webassembly.org) using [Binaryen](https://github.com/WebAssembly/binaryen). It generates lean and mean WebAssembly modules while being just an `npm install` away.
|
7 | 7 |
|
@@ -45,50 +45,17 @@ Motivation
|
45 | 45 |
|
46 | 46 | > I do think [compiling TypeScript into WASM] is tremendously useful. It allows JavaScript developers to create WASM modules without having to learn C. – Colin Eberhardt, [Exploring different approaches to building WebAssembly modules](http://blog.scottlogic.com/2017/10/17/wasm-mandelbrot.html) (Oct 17, 2017)
|
47 | 47 |
|
48 |
| -Instructions |
49 |
| ------------- |
| 48 | +Further resources |
| 49 | +----------------- |
50 | 50 |
|
51 |
| -For general usage instructions, please refer to the [documentation](https://docs.assemblyscript.org) instead. The following sets up a *development environment* of the compiler, for example if you plan to make a pull request: |
| 51 | +* [Documentation](https://docs.assemblyscript.org)<br /> |
| 52 | + Introduction, quick start, examples and general usage instructions. |
52 | 53 |
|
53 |
| -``` |
54 |
| -$> git clone https://github.com/AssemblyScript/assemblyscript.git |
55 |
| -$> cd assemblyscript |
56 |
| -$> npm install |
57 |
| -$> npm link |
58 |
| -$> npm run clean |
59 |
| -``` |
| 54 | +* [Development instructions](https://docs.assemblyscript.org/details/development)<br /> |
| 55 | + How to set up a development environment (to submit a pull request). |
60 | 56 |
|
61 |
| -Note that a fresh clone of the compiler will use the distribution files in `dist/`, but after an `npm run clean` it will run [the sources](./src) directly through ts-node, which is useful in development. This condition can also be checked by running `asc -v` (it is running the sources if it states `-dev`). Also please see our [contribution guidelines](./CONTRIBUTING.md) before making your first pull request. |
| 57 | +* [Project governance](https://github.com/AssemblyScript/meta)<br /> |
| 58 | + Meta information related to the AssemblyScript project. |
62 | 59 |
|
63 |
| -Building |
64 |
| --------- |
65 |
| - |
66 |
| -To build an UMD bundle to `dist/assemblyscript.js` (depends on [binaryen.js](https://github.com/AssemblyScript/binaryen.js)), including a browser version of asc to `dist/asc.js` (depends on assemblyscript.js): |
67 |
| - |
68 |
| -``` |
69 |
| -$> npm run build |
70 |
| -``` |
71 |
| - |
72 |
| -Cleaning the distribution files (again): |
73 |
| - |
74 |
| -``` |
75 |
| -$> npm run clean |
76 |
| -``` |
77 |
| - |
78 |
| -Linting potential changes: |
79 |
| - |
80 |
| -``` |
81 |
| -$> npm run check |
82 |
| -``` |
83 |
| - |
84 |
| -Running the [tests](./tests): |
85 |
| - |
86 |
| -``` |
87 |
| -$> npm test |
88 |
| -``` |
89 |
| - |
90 |
| -Running everything in order (lint, clean, test, build, test): |
91 |
| - |
92 |
| -``` |
93 |
| -$> npm run all |
94 |
| -``` |
| 60 | +* [Media files](./media)<br /> |
| 61 | + Various media files, like logos etc. |
0 commit comments