You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Oct 22, 2020. It is now read-only.
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+6-1Lines changed: 6 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -1,8 +1,13 @@
1
1
# How to contribute
2
2
Contributions are always welcome, however, to keep things consistent, please review the following guidelines.
3
3
4
+
## Setting up your environment
5
+
Ensure that you have Ruby >= 2.4.4 installed on your system and then install all required dependencies by opening a command prompt / terminal in the WPXF folder and running ```bundle install```.
6
+
7
+
If bundler is not present on your system, you can install it by running ```gem install bundler```.
8
+
4
9
## Update unit tests
5
-
If you change a core piece of functionality (i.e. in ```lib/wpxf/*```) then ensure the corresponding unit tests in the ```spec``` folder are updated.
10
+
If you change a core piece of functionality (i.e. in ```lib/*```) then ensure the corresponding unit tests in the ```spec``` folder are updated.
6
11
7
12
For more information on writing unit tests with RSpec, see https://relishapp.com/rspec
@@ -26,10 +22,13 @@ This branch is for the development of the next major release. It will contain co
26
22
27
23
Do not use this branch unless you are prepared to encounter bugs.
28
24
29
-
### What do I need to run it?
30
-
Ensure that you have Ruby >= 2.4.4 installed on your system and then install all required dependencies by opening a command prompt / terminal in the WPXF folder and running ```bundle install```.
25
+
### Installation
26
+
To install the latest build of the v2 branch, run `gem install wpxf --pre`.
31
27
32
-
If bundler is not present on your system, you can install it by running ```gem install bundler```.
28
+
After installation, you can launch the WordPress Exploit Framework console by running `wpxf`.
29
+
30
+
### What do I need to run it?
31
+
Ruby >= 2.4.4 is required to run WordPress Exploit Framework.
33
32
34
33
### Troubleshooting Installation
35
34
#### Debian Systems
@@ -51,7 +50,7 @@ If you are experiencing errors that indicate that ```libcurl.dll``` could not be
51
50
The latest version can be downloaded from http://curl.haxx.se/download.html. As of 16/05/2016, the latest release is marked as ```Win32 2000/XP zip 7.40.0 libcurl SSL```. After downloading the archive, extract the contents of the bin directory into your Ruby bin directory (if prompted, don't overwrite any existing DLLs).
52
51
53
52
### How do I use it?
54
-
Open a command prompt / terminal in the directory that you have downloaded WordPress Exploit Framework to, and start it by running ```ruby wpxf.rb```.
53
+
Start the WordPress Exploit Framework console by running `wpxf`.
55
54
56
55
Once loaded, you'll be presented with the wpxf prompt, from here you can search for modules using the ```search``` command or load a module using the ```use``` command.
0 commit comments