Skip to content

Commit 0a5d8fd

Browse files
solardizmagnumripper
authored andcommitted
[skip ci] Update README*
1 parent 2d7cb0b commit 0a5d8fd

File tree

5 files changed

+32
-198
lines changed

5 files changed

+32
-198
lines changed

CONTRIBUTING.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.
44
- If you have questions, please ask them first in the mailing list john-users at lists.openwall.com;
5-
- Use issues to keep track of ideas, enhancements, tasks, and bugs. NEVER as a support forum;
5+
- Use GitHub issues to keep track of ideas, enhancements, tasks, and bugs. NEVER as a support forum;
66

77
## Bug Reports
88

README

-1
This file was deleted.

README-jumbo

-16
This file was deleted.

README.md

+30-29
Original file line numberDiff line numberDiff line change
@@ -7,25 +7,30 @@
77
[![Search hit](https://img.shields.io/github/search/magnumripper/JohnTheRipper/goto.svg?label=GitHub%20Hits)](https://github.com/search?utf8=%E2%9C%93&q=john%20the%20ripper&type=)
88

99
John the Ripper
10-
====================
10+
===============
1111

12-
This is a community-enhanced, "jumbo" version of John the Ripper.
13-
It has a lot of code, documentation, and data contributed by the
14-
user community. This is not "official" John the Ripper code. It is
15-
very easy for new code to be added to jumbo: the quality requirements
16-
are low. This means that you get a lot of functionality that is not
17-
"mature" enough or is otherwise inappropriate for the official JtR,
18-
which in turn also means that bugs in this code are to be expected.
12+
This is the community-enhanced, "jumbo" version of John the Ripper.
13+
It has a lot of code, documentation, and data contributed by jumbo
14+
developers and the user community. It is easy for new code to be added
15+
to jumbo, and the quality requirements are low, although lately we've
16+
started subjecting all contributions to quite some automated testing.
17+
This means that you get a lot of functionality that is not necessarily
18+
"mature", which in turn means that bugs in this code are to be expected.
1919

2020
If you have any comments on this release or on JtR in general, please
21-
join the john-users mailing list and post in there.
21+
join the john-users mailing list and post in there:
22+
23+
https://www.openwall.com/lists/john-users/
2224

2325
Licensing info:
24-
http://openwall.info/wiki/john/licensing
26+
27+
https://openwall.info/wiki/john/licensing
2528

2629
For contributions to John the Ripper Jumbo, please use a
2730
[pull requested (PR) on GitHub](https://github.com/magnumripper/JohnTheRipper/blob/bleeding-jumbo/CONTRIBUTING.md).
2831

32+
Included below is basic John the Ripper core documentation.
33+
2934
---
3035

3136
John the Ripper password cracker.
@@ -89,7 +94,7 @@ choose the executable that fits your system best, e.g. "john-omp" to
8994
take advantage of multiple CPUs and/or CPU cores.
9095

9196

92-
Features and performance.
97+
Features.
9398

9499
John the Ripper is designed to be both feature-rich and fast. It
95100
combines several cracking modes in one program and is fully
@@ -138,21 +143,19 @@ these larger files for cracking, a corresponding bundled *2john program
138143
should be used first, and then its output fed into JtR -jumbo.
139144

140145

141-
Graphical User Interface (GUI).
146+
Graphical User Interface (GUI).
142147

143148
There is an official GUI for John the Ripper: Johnny.
144149

145-
Despite the fact that Johnny is oriented onto core john, all basic
146-
functionality is supposed to work in all versions, even Jumbo. So,
147-
password could be loaded from file and cracked with different
148-
options.
150+
Despite the fact that Johnny is oriented onto JtR core, all basic
151+
functionality is supposed to work in all versions, including jumbo.
149152

150-
Johnny is a separate program, therefore, you need to have John the
151-
Ripper installed in order to use it.
153+
Johnny is a separate program, therefore you need to have John the Ripper
154+
installed in order to use it.
152155

153-
You could find more info about releases and Johnny on the wiki:
156+
More information about Johnny and its releases is on the wiki:
154157

155-
http://openwall.info/wiki/john/johnny
158+
https://openwall.info/wiki/john/johnny
156159

157160

158161
Documentation.
@@ -162,23 +165,21 @@ the recommended order of reading:
162165

163166
* INSTALL - installation instructions
164167
* OPTIONS - command line options and additional utilities
165-
* EXAMPLES - usage examples - strongly recommended
166168
* MODES - cracking modes: what they are
167-
* FAQ - frequently asked questions
168-
* BUGS - list of known bugs
169-
* DYNAMIC - how to use dynamic format in JtR
170-
* DYNAMIC COMPILER FORMATS - List of known hash formats built using the dynamic compiler
171-
* DYNAMIC_SCRIPTING - how to build/optimise a format that uses dynamic
172-
* README.bash-completion - how to enable bash completion for JtR
173-
* CONTACT (*) - how to contact the author or otherwise obtain support
174169
* CONFIG (*) - how to customize
175-
* EXTERNAL (*) - defining an external mode
176170
* RULES (*) - wordlist rules syntax
171+
* EXTERNAL (*) - defining an external mode
172+
* EXAMPLES - usage examples - strongly recommended
173+
* FAQ - guess
177174
* CHANGES (*) - history of changes
175+
* CONTACT (*) - how to contact the author or otherwise obtain support
178176
* CREDITS (*) - credits
179177
* LICENSE - copyrights and licensing terms
180178
* COPYING - GNU GPL version 2, as referenced by LICENSE above
181179

182180
(*) most users can safely skip these.
183181

182+
There are a lot of additional documentation files in jumbo's "doc"
183+
directory, which you'll also want to explore.
184+
184185
Happy reading!

doc/README

-151
This file was deleted.

doc/README

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../README.md

0 commit comments

Comments
 (0)