Skip to content

Commit

Permalink
little changes in the readme
Browse files Browse the repository at this point in the history
  • Loading branch information
merrychap committed Nov 29, 2017
1 parent f5e231d commit 3eb37dc
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 11 deletions.
11 changes: 9 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,23 @@ Shellen is an interactive shellcoding environment. If you want a handy tool to w

It uses [keystone](https://github.com/keystone-engine/keystone) and [capstone](https://github.com/aquynh/capstone) engines for all provided operations.

Shellen *works only on python3*, but it will be changed in the future!
Shellen **works only on python3**. Maybe it will be changed in the future.

## Installing
You can install the stable version of shellen using pip3:
```
$ sudo pip3 install shellen
```

Or if you already have all required packages (see [Requirements](#requirements)):
```
$ python3 setup.py install
```

If you have any trouble with installing keystone-engine, then you should compile it by yourself (see the [COMPILE.md](https://github.com/keystone-engine/keystone/blob/master/docs/COMPILE.md) file in the [keystone](https://github.com/keystone-engine/keystone) repository)

## How to run:
To run shellen just type the next in your terminal:
After installing shellen and all its required packages, you can run shellen just by typing the next in your terminal:
```sh
$ shellen
```
Expand Down
18 changes: 9 additions & 9 deletions shellen/shell.py
Original file line number Diff line number Diff line change
Expand Up @@ -82,22 +82,22 @@ def help(self, *args):
cprint((
'\n<white,bold>PROMPT INFO</>\n'
' The prompt format is <white,bold>mode</>:<white,bold>arch</>\n'
' <white,bold> mode</> is a current <white,underline>assembly mode</> (by default it\'s asm). See below for more information.\n'
' <white,bold> arch</> is a chosen processor <white,underline>architecture</> (by default it\'s x86_32).\n'
' <white,bold>* mode</> is a current <white,underline>assembly mode</> (by default it\'s asm). See below for more information.\n'
' <white,bold>* arch</> is a chosen processor <white,underline>architecture</> (by default it\'s x86_32).\n'
'\n<white,bold>BASIC</>\n'
' Basic commands are listed below:\n'
' <white,bold> clear</>: Clear the terminal screen.\n'
' <white,bold> help</>: Show this help message.\n'
' <white,bold> quit, q, exit</>: Finish the current session and quit.\n'
' <white,bold>* clear</>: Clear the terminal screen.\n'
' <white,bold>* help</>: Show this help message.\n'
' <white,bold>* quit, q, exit</>: Finish the current session and quit.\n'
'\n<white,bold>MODES</>\n'
' If you want to change a current mode, then just type the name of a mode.\n'
' There are two assembly modes (each is described below):\n'
' <white,bold> asm</>: Assembler mode.\n'
' <white,bold> dsm</>: Disassembler mode.\n'
' <white,bold>* asm</>: Assembler mode.\n'
' <white,bold>* dsm</>: Disassembler mode.\n'
'\n<white,bold>COMMON COMMANDS FOR MODES</>\n'
' Common commands can be used for both <white, underline>asm</> and <white, underline>dsm</> modes.\n'
' <white,bold> archs</>: Print a table of available architectures for a current mode.\n'
' <white,bold> setarch [arch]</>: Change current processor architecture.\n'
' <white,bold>* archs</>: Print a table of available architectures for a current mode.\n'
' <white,bold>* setarch [arch]</>: Change current processor architecture.\n'
'\n<white,bold>ASSEMBLY MODE</>\n'
' <white,bold>asm</> mode is intended for assembling instructions.\n'
' To assembly instuctions, write them separated by colons.\n'
Expand Down

0 comments on commit 3eb37dc

Please sign in to comment.