Skip to content

Commit

Permalink
doc: updated TOC in README, added one to dev guide
Browse files Browse the repository at this point in the history
  • Loading branch information
obilodeau committed Dec 14, 2023
1 parent f8be085 commit 55f27f6
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 10 deletions.
18 changes: 8 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,23 +40,21 @@ research use cases in mind.


## Table of Contents
- [Supported Systems](#supported-systems)
- [Installing](#installing)
* [Supported Systems](#supported-systems)
* [Installing](#installing)
* [Using pipx](#using-pipx)
* [Using the Docker Image](#using-the-docker-image)
* [From Git Source](#from-git-source)
* [Installing on Windows](#installing-on-windows)
* [Building the Docker Image](#building-the-docker-image)
- [Using PyRDP](#using-pyrdp)
* [Using the PyRDP Monster-in-the-Middle](#using-the-pyrdp-monster-in-the-middle)
* [Using PyRDP](#using-pyrdp)
* [Using the PyRDP Monster\-in\-the\-Middle](#using-the-pyrdp-monster-in-the-middle)
* [Using the PyRDP Player](#using-the-pyrdp-player)
* [Using the PyRDP Certificate Cloner](#using-the-pyrdp-certificate-cloner)
* [Using PyRDP Convert](#using-pyrdp-convert)
* [Configuring PyRDP](#configuring-pyrdp)
* [Advanced Usage](#advanced-usage)
* [Docker Specific Usage Instructions](#docker-specific-usage-instructions)
- [PyRDP Lore](#pyrdp-lore)
- [Contributing to PyRDP](#contributing-to-pyrdp)
- [Acknowledgements](#acknowledgements)
* [PyRDP Lore](#pyrdp-lore)
* [Contributing to PyRDP](#contributing-to-pyrdp)
* [Acknowledgements](#acknowledgements)


## Supported Systems
Expand Down
7 changes: 7 additions & 0 deletions docs/devel.adoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,12 @@
= Development guide

:toc:
:toc-placement!:

This is a guide with quick recipes meant for PyRDP developers.

toc::[]

== Install from git source on Linux

We recommend installing PyRDP in a https://packaging.python.org/guides/installing-using-pip-and-virtual-environments/[virtualenv environment] to avoid dependency issues.
Expand Down

0 comments on commit 55f27f6

Please sign in to comment.