Merge pull request #96 from antoinevg/antoinevg/pre-release

Pre-release chores

CHANGELOG.md

@@ -0,0 +1,45 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+<!--
+## [Unreleased]
+-->
+
+## [3.0.0] - 2024-06-18
+### Added
+- Facedancer documentation has been updated and can be found at: [https://facedancer.readthedocs.io](https://facedancer.readthedocs.io)
+- A new backend has been added for the Great Scott Gadgets Cynthion.
+- Emulations can now set USB device speed on supported boards.
+
+### Changed
+- The Facedancer core API has been rewritten. See the Facedancer documentation for details.
+- Some legacy applets have been replaced with new examples based on the modern Facedancer core:
+  - `facedancer-ftdi.py` => `ftdi-echo.py`
+  - `facedancer-keyboard.py` => `rubber-ducky.py`
+  - `facedancer-umass.py`    => `mass-storage.py`
+
+### Fixed
+- 64bit LBA support has been added to the `mass-storage.py` example. (Tx @shutingrz!)
+
+### Removed
+- The legacy Facedancer core has been removed. If you're using scripts or training materials that depend on features or APIs removed in `v3.0.x` please use `v2.9.x`.
+- All legacy applets not ported to the modern Facedancer core have been removed.
+
+
+## [2.9.0] - 2024-02-09
+
+This release is intended as a reference point for anyone who has scripts, training materials etc. that are based on Facedancer `v2.x` features or API's that have been deprecated from `v3` onwards.
+
+Any future bug-fixes or backports to Facedancer `2.9.x` should use the [`v2.9.x branch`](https://github.com/greatscottgadgets/facedancer/tree/v2.9.x) as the starting point for forks or PR's.
+
+### Deprecated
+- The current Facedancer core will be supersed by the implementation in `future/` with the `v3.0` release.
+
+
+[Unreleased]: https://github.com/greatscottgadgets/facedancer/compare/3.0.0...HEAD
+[3.0.0]: https://github.com/greatscottgadgets/facedancer/compare/2.9.0...3.0.0
+[2.9.0]: https://github.com/greatscottgadgets/facedancer/releases/tag/2.9.0

README.md

@@ -10,7 +10,7 @@ and some pretty significant new features.
 
 Install this package with the following command:
 
-    pip install .
+    pip install facedancer
 
 After that you can import the facedancer package as usual:
 

docs/Makefile

@@ -2,24 +2,18 @@
 #
 
 # You can set these variables from the command line.
-SPHINXOPTS    =
-SPHINXBUILD   = sphinx-build
-SOURCEDIR     = source
-BUILDDIR      = build
+SPHINXOPTS	  =
+SPHINXBUILD	  = sphinx-build
+SOURCEDIR	  = source
+BUILDDIR	  = build
 
 # Put it first so that "make" without argument is like "make help".
 help:
 	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
 
 .PHONY: help Makefile
 
-# api docs
-apidocs:
-	rm -rf source/api_docs/
-	sphinx-apidoc -o source/api_docs/ ../facedancer
-
 # Catch-all target: route all unknown targets to Sphinx using the new
 # "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
 %: Makefile
 	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
-

docs/requirements.txt

@@ -1,10 +1,9 @@
+setuptools
 sphinx==7.2.6
 sphinx_rtd_theme==2.0.0
+sphinxcontrib-apidoc
 readthedocs-sphinx-search==0.3.2
 jinja2==3.1.4
 
 # needed to build api docs
-prompt_toolkit
-pyusb
-pyserial
-libusb1
+facedancer @ git+https://github.com/greatscottgadgets/facedancer