Skip to content

Commit 5dd6eb4

Browse files
author
Eshaan Bansal
authored
Update README.md
1 parent f3ef198 commit 5dd6eb4

File tree

1 file changed

+21
-10
lines changed

1 file changed

+21
-10
lines changed

README.md

Lines changed: 21 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -13,29 +13,40 @@ A CTF framework(in flask) for HackTheBox style machines.
1313

1414
## How To Use
1515

16-
$ git clone https://github.com/abs0lut3pwn4g3/RTB-CTF-Framework
17-
$ cd RTB-CTF-Framework/src/
18-
$ virtualenv -p /usr/bin/python3 venv
19-
$ source venv/bin/activate
20-
[venv]$ pip install -r requirements.txt
21-
[venv]$ python run.py
16+
### Requirements
17+
18+
* `Python 3.7.3` or atleast `> 3.6`.
19+
* Packages: [`src/requirements.txt`](src/requirements.txt).
20+
21+
```bash
22+
$ git clone https://github.com/abs0lut3pwn4g3/RTB-CTF-Framework
23+
$ cd RTB-CTF-Framework/src/
24+
$ virtualenv -p /usr/bin/python3 venv
25+
$ source venv/bin/activate
26+
[venv]$ pip install -r requirements.txt
27+
[venv]$ python run.py
28+
```
2229

2330
Using this as simple as anything. Just configure your CTF settings in [`config.py`](https://github.com/abs0lut3pwn4g3/RTB-CTF-Framework/blob/master/src/FlaskRTBCTF/config.py).
2431

2532
#### Creating database instance file
2633

2734
Locally or for docker,
2835

29-
$ source venv/bin/activate
30-
$ python3 # open python interpreter
31-
>>> from FlaskRTBCTF import db, create_app
32-
>>> db.create_all(app=create_app())
36+
```bash
37+
$ source venv/bin/activate
38+
$ python3 # open python interpreter
39+
>>> from FlaskRTBCTF import db, create_app
40+
>>> db.create_all(app=create_app())
41+
```
3342

3443
For Heroku,
3544

45+
```bash
3646
$ heroku run python
3747
>>> from FlaskRTBCTF import db, create_app
3848
>>> db.create_all(app=create_app())
49+
```
3950

4051
## To-do
4152

0 commit comments

Comments
 (0)