qilingframework / qilingframework/qiling

Linked to wiki installation instructions from source are incorrect

Open Beginner friendly
#1,628 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
6.1k
Forks
798
Avg merge
1d 1h
Merged PRs (30d)
9

Description

ISSUE
The linked to setup guide on the README page points to https://github.com/qilingframework/qiling/wiki/Installation which currently specifies installation from source instructions as:

git clone https://github.com/qilingframework/qiling.git
cd qiling
git submodule update --init --recursive
pip install -r requirements.txt
python setup.py install

The correct installation instructions from source are documented properly in the qiling docs at https://docs.qiling.io/en/latest/install/

python3 -m venv qilingenv
source qilingenv/bin/activate
git clone -b dev https://github.com/qilingframework/qiling.git
cd qiling && git submodule update --init --recursive
pip3 install .

Recommended fix
Either update the wiki entry to reflect the installation from source instructions in the qiling docs or just change the link in the readme to point at the installation instructions in the qiling docs

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the installation link in the README and compare it with the source-installation instructions at https://docs.qiling.io/en/latest/install/. Update the README link or the GitHub wiki entry as appropriate, then verify that the resulting instructions match the documented Python setup and source installation steps.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
1-3 hours
Activity status
Quiet
Clarity
Clearly specified
Newbie friendliness
78/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.