diff --git a/README.md b/README.md index 0790fe9..972b5bc 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ 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: @@ -13,8 +13,15 @@ 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 ``` diff --git a/shellen/shell.py b/shellen/shell.py index 6b40110..68d0d0d 100644 --- a/shellen/shell.py +++ b/shellen/shell.py @@ -82,22 +82,22 @@ def help(self, *args): cprint(( '\nPROMPT INFO\n' ' The prompt format is mode:arch\n' - ' • mode is a current assembly mode (by default it\'s asm). See below for more information.\n' - ' • arch is a chosen processor architecture (by default it\'s x86_32).\n' + ' * mode is a current assembly mode (by default it\'s asm). See below for more information.\n' + ' * arch is a chosen processor architecture (by default it\'s x86_32).\n' '\nBASIC\n' ' Basic commands are listed below:\n' - ' • clear: Clear the terminal screen.\n' - ' • help: Show this help message.\n' - ' • quit, q, exit: Finish the current session and quit.\n' + ' * clear: Clear the terminal screen.\n' + ' * help: Show this help message.\n' + ' * quit, q, exit: Finish the current session and quit.\n' '\nMODES\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' - ' • asm: Assembler mode.\n' - ' • dsm: Disassembler mode.\n' + ' * asm: Assembler mode.\n' + ' * dsm: Disassembler mode.\n' '\nCOMMON COMMANDS FOR MODES\n' ' Common commands can be used for both asm and dsm modes.\n' - ' • archs: Print a table of available architectures for a current mode.\n' - ' • setarch [arch]: Change current processor architecture.\n' + ' * archs: Print a table of available architectures for a current mode.\n' + ' * setarch [arch]: Change current processor architecture.\n' '\nASSEMBLY MODE\n' ' asm mode is intended for assembling instructions.\n' ' To assembly instuctions, write them separated by colons.\n'