Linked to wiki installation instructions from source are incorrect
Nobody has claimed this yet.
Assessment
- Difficulty
- 1/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 78/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Quiet
- Tech stack
- python
- Domain
- documentation
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.
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
- Dominant language
- Python
- Stars
- 6.1k
- Forks
- 798
- Avg merge
- 1d 1h
- Merged PRs (30d)
- 9
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from qilingframework/qiling
-
Difficulty 2/5 Half a day Newbie friendliness 82/100
qilingframework/qiling#1640 ·
-
Difficulty 1/5 Under an hour Newbie friendliness 68/100
qilingframework/qiling#1460 ·
-
Difficulty 1/5 Under an hour Newbie friendliness 68/100
qilingframework/qiling#1458 ·
-
Difficulty 3/5 1-2 days Newbie friendliness 70/100
qilingframework/qiling#1665 ·
-
Difficulty 5/5 Over a week Newbie friendliness 35/100
qilingframework/qiling#1645 · 2 comments ·
All issues in qilingframework/qiling
Similar issues
-
documentation help wanted
Difficulty 2/5 1-3 hours Newbie friendliness 90/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 90/100
simonw/sqlite-utils#872 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100