Prepare for the first release

.github/workflows/CI.yml

@@ -97,7 +97,7 @@ jobs:
   linux:
     # Skip building pull requests from the same repository
     if: ${{ github.event_name == 'push' || (github.event_name == 'pull_request' && github.event.pull_request.head.repo.full_name != github.repository) }}
-    runs-on: macos-latest
+    runs-on: ubuntu-latest
     env:
       # Disable output buffering in an attempt to get readable errors
       PYTHONUNBUFFERED: '1'

MANIFEST.in

@@ -1,12 +1,8 @@
 include Cargo.lock
 include Cargo.toml
-include README.md
 include build.rs
 include requirements.txt
 include copy-ghidra.py
 recursive-include src *
 recursive-include icicle-emu *
-recursive-include python *.py
-recursive-include python *.pyi
-recursive-include python py.typed
 recursive-include python/icicle/Ghidra *

README.md

@@ -2,16 +2,17 @@
 
 This project is an easy to use Python wrapper around [icicle-emu](https://github.com/icicle-emu/icicle-emu). You can read more about Icicle in the paper: [Icicle: A Re-designed Emulator for Grey-Box Firmware Fuzzing](https://arxiv.org/pdf/2301.13346.pdf)
 
-## Requirements
+## Installation
 
-- [Python 3.7+](https://www.python.org/downloads/)
-- [Rust 1.48](https://rustup.rs/)
+You can install the [latest release](https://github.com/mrexodia/icicle-python/releases) from [PyPI](https://pypi.org/project/icicle-emu):
 
-## Building
+```
+pip -m install icicle-emu
+```
 
-TODO: talk about the submodule
+## Development
 
-TODO: clone ghidra and set `GHIDRA_SRC` environment variable
+_Note_: You need to install [Rust 1.48](https://rustup.rs) or later to build from source.
 
 Set up a virtual environment:
 
@@ -27,5 +28,5 @@ Get the dependencies and build:
 
 ```shell
 pip install -r requirements.txt
-maturin develop
-```
+python setup.py develop
+```

setup.cfg

@@ -27,4 +27,3 @@ package_dir =
 zip_safe = False
 setup_requires = setuptools-rust >= 0.12.1;
 python_requires = >=3.7
-include_package_data = True