1
0
mirror of https://github.com/hashcat/hashcat.git synced 2024-11-22 08:08:10 +00:00

Update README.md

- In README.md, fix numbering
- Simplify 5) and add 8) which tells people to use array[index + 0] if they do array[index + 1]
This commit is contained in:
Jens Steube 2015-12-06 16:42:19 +01:00
parent 7535af533a
commit 8438f808cd

View File

@ -24,11 +24,12 @@ Contributions are welcome and encouraged, provided your code is of sufficient qu
1. Licensed under MIT license, or dedicated to public domain (BSD, GPL, etc. code is incompatible) 1. Licensed under MIT license, or dedicated to public domain (BSD, GPL, etc. code is incompatible)
2. Adheres to either C89, C90, or C99 standards 2. Adheres to either C89, C90, or C99 standards
2. Compiles cleanly with no warnings when compiled with `-W -Wall -std=c99` 3. Compiles cleanly with no warnings when compiled with `-W -Wall -std=c99`
3. Uses [Allman-style](https://en.wikipedia.org/wiki/Indent_style#Allman_style) code blocks & indentation 4. Uses [Allman-style](https://en.wikipedia.org/wiki/Indent_style#Allman_style) code blocks & indentation
4. Uses 2-character tabs and 2-character indentations 5. Uses 2-spaces as indentation or a tab if it's required (for example: Makefiles)
5. Uses lower-case function and variable names 6. Uses lower-case function and variable names
6. 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)`) 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
You can use GNU Indent to help assist you with the style requirements: You can use GNU Indent to help assist you with the style requirements: