Split out AUTHORS.md and HACKING.md from README.md

pull/13/head
Daniel Roethlisberger 10 years ago
parent b8213e756d
commit b8ecbcd773

@ -0,0 +1,20 @@
# Authors
SSLsplit was written and is being maintained by
[Daniel Roethlisberger](https://daniel.roe.ch/).
The following individuals have contributed to the codebase by submitting
patches or pull requests, in chronological order of their first contribution:
- Steve Wills (@swills)
- Landon Fuller (@landonf)
- Wayne Jensen (@wjjensen)
Many more individuals have contributed by reporting bugs or feature requests.
See [issue tracker on Github][1], `NEWS.md` and `git log` for details.
[1] https://github.com/droe/sslsplit/issues
All your contributions are greatly appreciated; without you, SSLsplit would not
be what it is today.

@ -0,0 +1,50 @@
# Development
SSLsplit is being developed on Github as [droe/sslsplit][1].
[1] https://github.com/droe/sslsplit
## Reporting bugs
Please use the Github issue tracker for bug reports. Including the following
information will allow faster analysis of the problem:
- Output of `sslsplit -V`
- Output of `uname -a`
- Exact command line arguments used to run SSLsplit
- The NAT redirection rules you are using, if applicable
Before submitting a bug report, please make sure that running `make test` from
a git checkout produces no failed unit tests on your system.
## Contributing patches
For patch submissions, please send me pull requests on Github. If you have
larger changes in mind, feel free to open an issue first to discuss
implications. If you are interested in contributing and don't know where to
start, take a look at the [open issues][2]. In particular, [porting features
over to not yet supported platforms][3] is always very much appreciated. When
submitting code, even though it is not a requirement, it is still appreciated
if you also update the manual page and other documentation as necessary and
include as many meaningful unit tests for your code as possible.
[2] https://github.com/droe/sslsplit/issues
[3] https://github.com/droe/sslsplit/labels/portability
See `HACKING.md` for the list of contributors.
## Branching model
With the 0.4.10 release as a starting point, SSLsplit is using [Vincent
Driessen's branching model][4]. The default `master` branch points to the
latest tagged release, while the `develop` branch is where development happens.
When preparing a release, there may or may not be a `release/x.y.z` branch off
`develop`, but in either case, the tagged release is merged back to `master`.
Larger features are developed in feature branches off the `develop` branch.
[4] http://nvie.com/posts/a-successful-git-branching-model/

@ -43,6 +43,12 @@ SSLsplit currently supports the following operating systems and NAT mechanisms:
- Linux: netfilter REDIRECT and TPROXY
- Mac OS X: pf rdr and ipfw fwd
Support for local process information (`-i`) is currently available on Mac OS X
and FreeBSD.
SSL/TLS features and compatibility greatly depend on the version of OpenSSL
linked against; for optimal results, use the latest 1.0.1 series release.
## Installation
@ -59,12 +65,11 @@ You can override the default install prefix (`/usr/local`) by setting `PREFIX`.
For more build options see `GNUmakefile`.
## Development
## Documentation
SSLsplit is being developed on Github. For bug reports, please use the Github
issue tracker. For patch submissions, please send me pull requests.
https://github.com/droe/sslsplit
See NEWS.md for release notes listing significant changes between releases.
See HACKING.md for information on development and how to submit bug reports.
See AUTHORS.md for the list of contributors.
## License
@ -82,17 +87,3 @@ Marlinspike, but shares no source code with them.
SSLsplit includes `khash.h` by Attractive Chaos.
## Contributors
The following individuals have contributed to the SSLsplit codebase by
submitting patches or pull requests, in chronological order of first
contribution:
- Daniel Roethlisberger (@droe), main author
- Steve Wills (@swills)
- Landon Fuller (@landonf)
- Wayne Jensen (@wjjensen)
See NEWS.md and `git log` for details.

Loading…
Cancel
Save