1
mirror of https://github.com/hashcat/hashcat synced 2024-12-23 14:13:43 +01:00

misc docs - thanks to honeyakshat999 for README suggestions

This commit is contained in:
Royce Williams 2018-11-01 07:33:17 -08:00
parent d4dad3e1e3
commit 0bd0d9a2ca
2 changed files with 9 additions and 9 deletions

View File

@ -12,7 +12,7 @@ Download the [latest release](https://hashcat.net/hashcat/) and unpack it in the
### Usage/Help ###
Please refer to the [Hashcat Wiki](https://hashcat.net/wiki/) and the output of `--help` for usage information and general help. A list of frequently asked questions may also be found [here](https://hashcat.net/wiki/doku.php?id=frequently_asked_questions). The [Hashcat Forums](https://hashcat.net/forum/) also contain a plethora of information.
Please refer to the [Hashcat Wiki](https://hashcat.net/wiki/) and the output of `--help` for usage information and general help. A list of frequently asked questions may also be found [here](https://hashcat.net/wiki/doku.php?id=frequently_asked_questions). The [Hashcat Forums](https://hashcat.net/forum/) also contains a plethora of information.
### Building ###
@ -28,11 +28,11 @@ Travis | Appveyor | Coverity
Contributions are welcome and encouraged, provided your code is of sufficient quality. Before submitting a pull request, please ensure your code adheres to the following requirements:
1. Licensed under MIT license, or dedicated to public domain (BSD, GPL, etc. code is incompatible)
1. Licensed under MIT license, or dedicated to the public domain (BSD, GPL, etc. code is incompatible)
2. Adheres to gnu99 standard
3. Compiles cleanly with no warnings when compiled with `-W -Wall -std=gnu99`
4. Uses [Allman-style](https://en.wikipedia.org/wiki/Indent_style#Allman_style) code blocks & indentation
5. Uses 2-spaces as indentation or a tab if it's required (for example: Makefiles)
5. Uses 2-spaces as the indentation or a tab if it's required (for example: Makefiles)
6. Uses lower-case function and variable names
7. Avoids the use of `!` and uses positive conditionals wherever possible (e.g., `if (foo == 0)` instead of `if (!foo)`, and `if (foo)` instead of `if (foo != 0)`)
8. Use code like array[index + 0] if you also need to do array[index + 1], to keep it aligned
@ -47,7 +47,7 @@ Your pull request should fully describe the functionality you are adding/removin
Solve only one problem in each pull request. If you're fixing a bug and adding a new feature, you need to make two separate pull requests. If you're fixing three bugs, you need to make three separate pull requests. If you're adding four new features, you need to make four separate pull requests. So on, and so forth.
If your patch fixes a bug, please be sure there is an [issue](https://github.com/hashcat/hashcat/issues) open for the bug before submitting a pull request. If your patch aims to improve performance or optimizes an algorithm, be sure to quantify your optimizations and document the trade-offs, and back up your claims with benchmarks and metrics.
If your patch fixes a bug, please be sure there is an [issue](https://github.com/hashcat/hashcat/issues) open for the bug before submitting a pull request. If your patch aims to improve performance or optimize an algorithm, be sure to quantify your optimizations and document the trade-offs, and back up your claims with benchmarks and metrics.
In order to maintain the quality and integrity of the **hashcat** source tree, all pull requests must be reviewed and signed off by at least two [board members](https://github.com/orgs/hashcat/people) before being merged. The [project lead](https://github.com/jsteube) has the ultimate authority in deciding whether to accept or reject a pull request. Do not be discouraged if your pull request is rejected!

View File

@ -5,7 +5,7 @@
##
- Added support to use --stdout in brain-client mode
- Added new option --stdin-timeout-abort which allows to set the time hashcat should wait for input in stdin mode before aborting
- Added new option --stdin-timeout-abort, to set how long hashcat should wait for stdin input before aborting
##
## Algorithms
@ -27,11 +27,11 @@
## Bugs
##
- Fixed automated calculatation of brain-session caused by not using all hashes in the hashlist
- Fixed endianness and invalid separator character in outfile format of hash-mode 16801 (WPA-PMKID-PMK)
- Fixed ignoring --brain-client-features configuration in case brain-server has attack positions informations from a previous run
- Fixed automated calculation of brain-session when not using all hashes in the hashlist
- Fixed endianness and invalid separator character in outfile format for hash-mode 16801 (WPA-PMKID-PMK)
- Fixed ignoring --brain-client-features configuration when brain-server has attack positions information from a previous run
- Fixed missing call to WSACleanup() to cleanly shutdown windows sockets system
- Fixed missing call to WSAStartup() and client indexing in order to start the brain server on windows
- Fixed missing call to WSAStartup() and client indexing in order to start the brain server on Windows
- Fixed out-of-bounds write in short-term memory of the brain-server
* changes v4.2.1 -> v5.0.0