README.md: Migrate configuration text to docs

angr · Nov 12, 2024 · b550a59 · b550a59
1 parent 345a043
commit b550a59
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 10 deletions.
diff --git a/README.md b/README.md
@@ -8,13 +8,3 @@ Some screenshots:
 
 [![Disassembly](screenshots/disassembly.png)](https://github.com/angr/angr-management/blob/master/screenshots/disassembly.png)
 [![Decompilation](screenshots/decompilation.png)](https://github.com/angr/angr-management/blob/master/screenshots/decompilation.png)
-
-## Usage
-
-## Configuration
-
-Configuration files locations vary by platform.
-
-- Windows: `~\AppData\Local\angr-management\config.toml`
-- macOS: `~/Library/Preferences/angr-management/config.toml`
-- Linux: `~/.config/angr-management/config.toml`
diff --git a/docs/quickstart.rst b/docs/quickstart.rst
@@ -61,3 +61,12 @@ Plugins may be installed by placing a subdirectory under :code:`plugins`. The di
   PLUGIN_CLS_NAME = TestPlugin.__name__
 
 This also allows you to import a plugin class from another package entirely. The plugin itself should inherit from :code:`BasePlugin`. Callbacks and events are a work in progress, so the API is subject to change. See :code:`TestPlugin` for an example of a multithreaded plugin sample.
+
+Configuration
+-------------
+
+Configuration files locations vary by platform:
+
+* Windows: :code:`~\AppData\Local\angr-management\config.toml`
+* macOS: :code:`~/Library/Preferences/angr-management/config.toml`
+* Linux: :code:`~/.config/angr-management/config.toml`