docs: Updated simulavr building instructions

Signed-off-by: Dmitry Butyugin <dmbutyugin@google.com>
This commit is contained in:
Dmitry Butyugin 2022-01-23 15:24:55 +01:00 committed by KevinOConnor
parent 7d57a7c4c8
commit 40702bf9db
1 changed files with 27 additions and 9 deletions

View File

@ -202,20 +202,33 @@ run this on a desktop class machine (not a Raspberry Pi) as it does
require significant cpu to run efficiently. require significant cpu to run efficiently.
To use simulavr, download the simulavr package and compile with python To use simulavr, download the simulavr package and compile with python
support: support. Note that the build system may need to have some packages (such as
swig) installed in order to build the python module.
``` ```
git clone git://git.savannah.nongnu.org/simulavr.git git clone git://git.savannah.nongnu.org/simulavr.git
cd simulavr cd simulavr
./bootstrap make python
./configure --enable-python make build
make
``` ```
Make sure a file like **./build/pysimulavr/_pysimulavr.*.so** is present
after the above compilation:
```
ls ./build/pysimulavr/_pysimulavr.*.so
```
This commmand should report a specific file (e.g.
**./build/pysimulavr/_pysimulavr.cpython-39-x86_64-linux-gnu.so**) and
not an error.
Note that the build system may need to have some packages (such as If you are on a Debian-based system (Debian, Ubuntu, etc.) you can
swig) installed in order to build the python module. Make sure the install the following packages and generate *.deb files for system-wide
file **src/python/_pysimulavr.so** is present after the above installation of simulavr:
compilation. ```
sudo apt update
sudo apt install g++ make cmake swig rst2pdf help2man texinfo
make cfgclean python debian
sudo dpkg -i build/debian/python3-simulavr*.deb
```
To compile Klipper for use in simulavr, run: To compile Klipper for use in simulavr, run:
@ -229,7 +242,12 @@ select SIMULAVR software emulation support. Then one can compile
Klipper (run `make`) and then start the simulation with: Klipper (run `make`) and then start the simulation with:
``` ```
PYTHONPATH=/path/to/simulavr/src/python/ ./scripts/avrsim.py out/klipper.elf PYTHONPATH=/path/to/simulavr/build/pysimulavr/ ./scripts/avrsim.py out/klipper.elf
```
Note that if you have installed python3-simulavr system-wide, you do
not need to set `PYTHONPATH`, and can simply run the simulator as
```
./scripts/avrsim.py out/klipper.elf
``` ```
Then, with simulavr running in another window, one can run the Then, with simulavr running in another window, one can run the