Skip to content

Commit

Permalink
Merge 0ed45b4 into 16de5ec
Browse files Browse the repository at this point in the history
  • Loading branch information
zachriggle committed Aug 22, 2016
2 parents 16de5ec + 0ed45b4 commit f33873c
Show file tree
Hide file tree
Showing 10 changed files with 18 additions and 40 deletions.
2 changes: 1 addition & 1 deletion LICENSE-pwntools.txt
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ directories:
- pwnlib/data/


Copyright (c) 2015 Gallopsled et al.
Copyright (c) 2015 Gallopsled and Zach Riggle

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
20 changes: 6 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# pwntools - CTF toolkit
![pwntools logo](https://github.com/Gallopsled/pwntools/blob/stable/docs/source/logo.png?raw=true)

[![Docs dev](https://readthedocs.org/projects/pwntools/badge/?version=dev)](https://docs.pwntools.com/en/dev)
[![Docs beta](https://readthedocs.org/projects/pwntools/badge/?version=beta)](https://docs.pwntools.com/en/beta)
[![Docs stable](https://readthedocs.org/projects/pwntools/badge/?version=stable)](https://docs.pwntools.com/en/stable)
[![Docs latest](https://readthedocs.org/projects/pwntools/badge/?version=latest)](https://pwntools.readthedocs.org/)
[![Docs 2.2.0](https://readthedocs.org/projects/pwntools/badge/?version=2.2.0)](https://pwntools.readthedocs.org/en/2.2.0)
[![PyPI](https://img.shields.io/pypi/v/pwntools.svg?style=flat)](https://pypi.python.org/pypi/pwntools/)
[![Gittip](https://img.shields.io/gittip/gallopsled.svg?style=flat)](https://www.gittip.com/gallopsled/)
[![Travis](https://travis-ci.org/Gallopsled/pwntools.svg?branch=stable)](https://travis-ci.org/Gallopsled/pwntools)
[![Coveralls](https://img.shields.io/coveralls/Gallopsled/pwntools/stable.svg)](https://coveralls.io/github/Gallopsled/pwntools?branch=stable)
[![Twitter](https://img.shields.io/badge/twitter-pwntools-4099FF.svg?style=flat)](https://twitter.com/pwntools)
Expand All @@ -31,7 +31,7 @@ It will drop you into a clean, Docker-ized container. There is nothing of value
[key]: https://gist.githubusercontent.com/zachriggle/efa2e0080ae6de2e8344/raw/4b503e9db54f009d97477d03d4ba5678471f8ff0/id_rsa

# Documentation
Our documentation is available at [docs.pwntools.com](https://docs.pwntools.com/)
Our documentation is available at [pwntools.readthedocs.org](https://pwntools.readthedocs.org/)

To get you started, we've provided some example solutions for past CTF challenges in our [write-ups repository](https://github.com/Gallopsled/pwntools-write-ups).

Expand All @@ -44,18 +44,10 @@ Most of the functionality of pwntools is self-contained and Python-only. You sh
```sh
apt-get update
apt-get install python2.7 python-pip python-dev git libssl-dev

# For cutting edge:
pip install --upgrade git+https://github.com/Gallopsled/pwntools.git@dev

# If you want early access to the next release to help file bugs:
pip install --upgrade git+https://github.com/Gallopsled/pwntools.git@beta

# If you just want it to work
pip install pwntools
pip install --upgrade git+https://github.com/Gallopsled/pwntools.git
```

However, some of the features (assembling/disassembling foreign architectures) require non-Python dependencies. For more information, see the [complete installation instructions here](https://docs.pwntools.com/en/dev/install.html).
However, some of the features (assembling/disassembling foreign architectures) require non-Python dependencies. For more information, see the [complete installation instructions here](https://pwntools.readthedocs.org/en/latest/install.html).


# Contribution
Expand Down
6 changes: 3 additions & 3 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@

# General information about the project.
project = u'pwntools'
copyright = u'2016, Gallopsled et al.'
copyright = u'2015, Zach Riggle'

# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
Expand Down Expand Up @@ -217,7 +217,7 @@
# (source start file, target name, title, author, documentclass [howto/manual]).
latex_documents = [
('index', 'pwntools.tex', u'pwntools Documentation',
u'2016, Gallopsled et al.', 'manual'),
u'2015, Zach Riggle', 'manual'),
]

intersphinx_mapping = {'python': ('https://docs.python.org/2.7', None),
Expand Down Expand Up @@ -250,7 +250,7 @@
# (source start file, name, description, authors, manual section).
man_pages = [
('index', 'pwntools', u'pwntools Documentation',
[u'2016, Gallopsled et al.'], 1)
[u'2015, Zach Riggle'], 1)
]

# If true, show URL addresses after external links.
Expand Down
14 changes: 0 additions & 14 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,20 +5,6 @@ pwntools
Written in Python, it is designed for rapid prototyping and development,
and intended to make exploit writing as simple as possible.

The primary location for this documentation is at docs.pwntools.com_, which uses
readthedocs_. It comes in three primary flavors:

- Stable_
- Beta_
- Dev_

.. _readthedocs: https://readthedocs.org
.. _docs.pwntools.com: https://docs.pwntools.com
.. _Stable: https://docs.pwntools.com/en/stable
.. _Beta: https://docs.pwntools.com/en/beta
.. _Dev: https://docs.pwntools.com/en/dev


Getting Started
---------------

Expand Down
2 changes: 1 addition & 1 deletion examples/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ the pwntools project.

We have a plan to create a separate repository with examples, primarily
exploits. Until we do so, we recommend new users to look at
https://docs.pwntools.com, as this is a better overview of our features.
https://pwntools.readthedocs.org, as this is a better overview of our features.

In no particular order the docstrings for each example:

Expand Down
2 changes: 1 addition & 1 deletion examples/gen-README.py
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
We have a plan to create a separate repository with examples, primarily
exploits. Until we do so, we recommend new users to look at
https://docs.pwntools.com, as this is a better overview of our features.
https://pwntools.readthedocs.org, as this is a better overview of our features.
In no particular order the docstrings for each example:
Expand Down
2 changes: 1 addition & 1 deletion extra/docker/Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
############################################################

FROM ubuntu:trusty
MAINTAINER Maintainer Gallopsled et al.
MAINTAINER Maintainer Zach Riggle

RUN apt-get update && apt-get install -y software-properties-common
RUN apt-add-repository --yes ppa:pwntools/binutils
Expand Down
4 changes: 2 additions & 2 deletions pwnlib/asm.py
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,7 @@ def which_binutils(util):
log.warning("""
Could not find %(util)r installed for %(context)s
Try installing binutils for this architecture:
https://docs.pwntools.com/en/dev/install/binutils.html
https://pwntools.readthedocs.org/en/latest/install/binutils.html
""".strip() % locals())
raise Exception('Could not find %(util)r installed for %(context)s' % locals())

Expand Down Expand Up @@ -179,7 +179,7 @@ def _assembler():
version = re.search(r' (\d\.\d+)', result).group(1)
if version < '2.19':
log.warn_once('Your binutils version is too old and may not work!\n' + \
'Try updating with: https://docs.pwntools.com/en/dev/install/binutils.html\n' + \
'Try updating with: https://pwntools.readthedocs.org/en/latest/install/binutils.html\n' + \
'Reported Version: %r' % result.strip())


Expand Down
2 changes: 1 addition & 1 deletion pwnlib/testexample.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
of the functionality. You can also add module-level doctests.
You can see what the documentation for this module will look like here:
https://docs.pwntools.com/en/dev/testexample.html
https://pwntools.readthedocs.org/en/latest/testexample.html
The tests for this module are run when the documentation is automatically-generated
by Sphinx. This particular module is invoked by an "automodule" directive, which
Expand Down
4 changes: 2 additions & 2 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -76,8 +76,8 @@
entry_points = {'console_scripts': console_scripts},
scripts = glob.glob("bin/*"),
description = "CTF framework and exploit development library.",
author = "Gallopsled et al.",
author_email = "#pwntools @ freenode.net",
author = "Zach Riggle",
author_email = "zachriggle@gmail.com",
url = 'https://pwntools.com',
download_url = "https://pwntools.com/tarball/stable",
install_requires = install_requires,
Expand Down

0 comments on commit f33873c

Please sign in to comment.