speculos 0.9.8.dev2__tar.gz → 0.9.8.dev4__tar.gz

{speculos-0.9.8.dev2/speculos.egg-info → speculos-0.9.8.dev4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: speculos
-Version: 0.9.8.dev2
+Version: 0.9.8.dev4
 Summary: Ledger Blue, Stax, Flex and Nano S/S+/X application emulator
 Author-email: Ledger <hello@ledger.fr>
 Project-URL: Homepage, https://github.com/LedgerHQ/speculos
@@ -51,6 +51,41 @@ Usage example:
 # ... and open a browser on http://127.0.0.1:5000
 ```
 
+## Installation
+
+### From Python `pypi` packages
+
+The easiest, stable way to install Speculos is with `pip`:
+
+```
+pip install speculos
+```
+
+It is advised to use Python virtualenv, otherwise admin rights will probably be
+necessary.
+
+
+### From sources
+
+Installing Speculos from sources is a bit heavier and, depending on the platform,
+complex, due to all the dependency needed for compiling the emulator.
+
+On Debian (10 or later) or Ubuntu (18.04 or later):
+
+```
+sudo apt install \
+    git cmake gcc-arm-linux-gnueabihf libc6-dev-armhf-cross gdb-multiarch \
+    python3-pyqt5 python3-construct python3-flask-restful python3-jsonschema \
+    python3-mnemonic python3-pil python3-pyelftools python3-requests \
+    qemu-user-static libvncserver-dev
+
+# from the root directory of the source repository
+pip install .
+```
+
+Dependency management will vary on other platforms; using Docker images and/or WSL
+should facilitate the installation.
+
 ## Bugs and contributions
 
 Feel free to open issues and create pull requests on this GitHub repository.

{speculos-0.9.8.dev2 → speculos-0.9.8.dev4}/README.md

@@ -18,6 +18,41 @@ Usage example:
 # ... and open a browser on http://127.0.0.1:5000
 ```
 
+## Installation
+
+### From Python `pypi` packages
+
+The easiest, stable way to install Speculos is with `pip`:
+
+```
+pip install speculos
+```
+
+It is advised to use Python virtualenv, otherwise admin rights will probably be
+necessary.
+
+
+### From sources
+
+Installing Speculos from sources is a bit heavier and, depending on the platform,
+complex, due to all the dependency needed for compiling the emulator.
+
+On Debian (10 or later) or Ubuntu (18.04 or later):
+
+```
+sudo apt install \
+    git cmake gcc-arm-linux-gnueabihf libc6-dev-armhf-cross gdb-multiarch \
+    python3-pyqt5 python3-construct python3-flask-restful python3-jsonschema \
+    python3-mnemonic python3-pil python3-pyelftools python3-requests \
+    qemu-user-static libvncserver-dev
+
+# from the root directory of the source repository
+pip install .
+```
+
+Dependency management will vary on other platforms; using Docker images and/or WSL
+should facilitate the installation.
+
 ## Bugs and contributions
 
 Feel free to open issues and create pull requests on this GitHub repository.

{speculos-0.9.8.dev2 → speculos-0.9.8.dev4}/docs/installation/build.md

@@ -10,20 +10,30 @@ For Debian (version 10 "Buster" or later) and Ubuntu (version 18.04 or later):
 
 ```shell
 sudo apt install \
-    cmake gcc-arm-linux-gnueabihf libc6-dev-armhf-cross gdb-multiarch \
+    git cmake gcc-arm-linux-gnueabihf libc6-dev-armhf-cross gdb-multiarch \
     python3-pyqt5 python3-construct python3-flask-restful python3-jsonschema \
     python3-mnemonic python3-pil python3-pyelftools python3-requests \
-    qemu-user-static
-
+    qemu-user-static libvncserver-dev
 ```
 
-For optional VNC support, please also install `libvncserver-dev`:
+Please note that VNC support (the `libvncserver-dev` package), although necessary
+for a Python installation, is optional when building only the launcher (see below).
+
+## Build & install
+
+Easiest way to build & install Speculos is with `pip`. It will not only compile
+the launcher, but will also install the Python package wrapped around it, which
+includes the high-level Speculos entrypoint, used (for instance) in the
+[Ragger](https://ledgerhq.github.io/ragger/) framework.
+
+Following command ought to be executed into a Python virtualenv, else admin
+rights will be necessary.
 
 ```shell
-sudo apt install libvncserver-dev
+pip install .
 ```
 
-## Build
+## Building the Speculos launcher only
 
 ### speculos
 

{speculos-0.9.8.dev2 → speculos-0.9.8.dev4}/speculos/__version__.py

@@ -12,5 +12,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '0.9.8.dev2'
-__version_tuple__ = version_tuple = (0, 9, 8, 'dev2')
+__version__ = version = '0.9.8.dev4'
+__version_tuple__ = version_tuple = (0, 9, 8, 'dev4')

{speculos-0.9.8.dev2 → speculos-0.9.8.dev4/speculos.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: speculos
-Version: 0.9.8.dev2
+Version: 0.9.8.dev4
 Summary: Ledger Blue, Stax, Flex and Nano S/S+/X application emulator
 Author-email: Ledger <hello@ledger.fr>
 Project-URL: Homepage, https://github.com/LedgerHQ/speculos
@@ -51,6 +51,41 @@ Usage example:
 # ... and open a browser on http://127.0.0.1:5000
 ```
 
+## Installation
+
+### From Python `pypi` packages
+
+The easiest, stable way to install Speculos is with `pip`:
+
+```
+pip install speculos
+```
+
+It is advised to use Python virtualenv, otherwise admin rights will probably be
+necessary.
+
+
+### From sources
+
+Installing Speculos from sources is a bit heavier and, depending on the platform,
+complex, due to all the dependency needed for compiling the emulator.
+
+On Debian (10 or later) or Ubuntu (18.04 or later):
+
+```
+sudo apt install \
+    git cmake gcc-arm-linux-gnueabihf libc6-dev-armhf-cross gdb-multiarch \
+    python3-pyqt5 python3-construct python3-flask-restful python3-jsonschema \
+    python3-mnemonic python3-pil python3-pyelftools python3-requests \
+    qemu-user-static libvncserver-dev
+
+# from the root directory of the source repository
+pip install .
+```
+
+Dependency management will vary on other platforms; using Docker images and/or WSL
+should facilitate the installation.
+
 ## Bugs and contributions
 
 Feel free to open issues and create pull requests on this GitHub repository.