Rooba
/
iced
mirror of https://github.com/icedland/iced.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update README

This commit is contained in:
0xd4d 2020-12-01 21:25:58 +01:00
parent 4054085f90
commit ab90e9f195
2 changed files with 21 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
build/README.md
View File

@ -15,8 +15,7 @@ Building and testing the Rust code requires:
- Rust: https://www.rust-lang.org/tools/install - Rust: https://www.rust-lang.org/tools/install
- Extra Rust stuff - Extra Rust stuff
- `rustup update` - `rustup update`
- `rustup component add rustfmt` - `rustup component add rustfmt clippy`
- `rustup component add clippy`
- `rustup target add wasm32-unknown-unknown` - `rustup target add wasm32-unknown-unknown`
- MSRV: `rustup toolchain install 1.20.0` - MSRV: `rustup toolchain install 1.20.0`
- Pass `--no-msrv` to `build-rust` if you don't want to install it - Pass `--no-msrv` to `build-rust` if you don't want to install it
@ -30,8 +29,7 @@ Building and testing the JavaScript code requires:
- Rust: https://www.rust-lang.org/tools/install - Rust: https://www.rust-lang.org/tools/install
- Extra Rust stuff - Extra Rust stuff
- `rustup update` - `rustup update`
- `rustup component add rustfmt` - `rustup component add rustfmt clippy`
- `rustup component add clippy`
- `rustup target add wasm32-unknown-unknown` - `rustup target add wasm32-unknown-unknown`
- Node.js >= 10.0.0: https://nodejs.org/en/download/ - Node.js >= 10.0.0: https://nodejs.org/en/download/
- wasm-pack: `npm install -g wasm-pack` or if it fails, see https://rustwasm.github.io/wasm-pack/installer/ - wasm-pack: `npm install -g wasm-pack` or if it fails, see https://rustwasm.github.io/wasm-pack/installer/
@ -43,10 +41,10 @@ Building and testing the Python code requires:
- Rust: https://www.rust-lang.org/tools/install - Rust: https://www.rust-lang.org/tools/install
- Extra Rust stuff - Extra Rust stuff
- `rustup update` - `rustup update`
- `rustup component add rustfmt` - `rustup component add rustfmt clippy`
- `rustup component add clippy` - Some C compiler, eg. `apt install gcc`
- Python >= 3.6: https://www.python.org/downloads/ - Python >= 3.6: https://www.python.org/downloads/
- `pip install -U setuptools wheel setuptools-rust mypy pylint sphinx` - `pip3 install -U setuptools wheel setuptools-rust mypy pylint sphinx`
# Building this repo # Building this repo

18
src/rust/iced-x86-py/README.md
View File

@ -4,7 +4,21 @@ TODO:
Prerequisites: Prerequisites:
- `Rust`: https://www.rust-lang.org/tools/install - Rust: https://www.rust-lang.org/tools/install
- `Python` >= 3.5 must be installed and in your `PATH` environment variable - Some C compiler, eg. `apt install gcc`
- Python >= 3.6: https://www.python.org/downloads/
- `pip3 install -U setuptools wheel setuptools-rust`
- `pip` if on Windows
If on Windows, replace `python3/pip3` with `python/pip`.
```sh
# Create the wheel
python3 setup.py bdist_wheel
# Install the built wheel
pip3 install --no-index -f dist iced-x86
# Uninstall your built copy
pip3 uninstall iced-x86
```
TODO: TODO: