Skip to content

Commit 3d591f3

Browse files
committed
Update README
1 parent 0dbcfe9 commit 3d591f3

File tree

1 file changed

+20
-12
lines changed

1 file changed

+20
-12
lines changed

README.md

Lines changed: 20 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,30 @@
1-
# Faasm CPython build
1+
# Faasm CPython WebAssembly build
22

3-
The CPython build uses a fork of
4-
[CPython](https://github.com/Shillaker/cpython/tree/faasm) along with other
5-
Python module forks in the `third-party` directory.
3+
This build cross-compiles CPython and a number of Python modules to WebAssembly
4+
for use in [Faasm](https://github.com/lsds/faasm).
5+
6+
You can see a list of the installed modules in the
7+
[`install_modules.sh`](scripts/install_modules.sh) script.
8+
9+
The build uses the [Faasm
10+
toolchain](https://github.com/Shillaker/faasm-toolchain) to cross-compile both
11+
CPython and C-extensions to WebAssembly.
12+
13+
## Code changes
14+
15+
The CPython build uses this slightly modified [fork of
16+
CPython](https://github.com/Shillaker/cpython/tree/faasm).
617

718
To see the changes made to CPython, see [this
819
compare](https://github.com/python/cpython/compare/v3.8.2...Shillaker:faasm).
9-
For numpy, see [this
10-
compare](https://github.com/numpy/numpy/compare/v1.19.2...Shillaker:faasm).
1120

12-
The build uses the [Faasm
13-
toolchain](https://github.com/Shillaker/faasm-toolchain) to compile CPython and
14-
C-extensions to WebAssembly (for use with
15-
[Faasm](https://github.com/lsds/faasm)).
21+
A similar (small) list of changes for numpy can be seen
22+
[here](https://github.com/numpy/numpy/compare/v1.19.2...Shillaker:faasm).
1623

1724
CPython is built statically, some notes on this process can be found
18-
[here](https://wiki.python.org/moin/BuildStatically). The Faasm CPython build
19-
borrows a lot of configuration from
25+
[here](https://wiki.python.org/moin/BuildStatically).
26+
27+
Several of the code changes to CPython and numpy were borrowed from
2028
[pyodide](https://github.com/iodide-project/pyodide).
2129

2230
## Set-up

0 commit comments

Comments
 (0)