Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve README #1775

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open

Improve README #1775

wants to merge 5 commits into from

Conversation

AnonymousWP
Copy link

@AnonymousWP AnonymousWP commented Apr 12, 2023 •
edited
Loading

Added

  • Add steps to containerise SpiderFoot: the steps were not even present, and only on the commercial website of Intel471 which leads to a "not found" page... That's why I added it to the README.
  • Add numbered list for steps

Changed

  • Remove blank lines in Dockerfile

smicallef
smicallef reviewed May 3, 2023
View reviewed changes
README.md
wget https://github.com/smicallef/spiderfoot/archive/v4.0.tar.gz && tar zxvf v4.0.tar.gz && cd spiderfoot-4.0
```

1. Install the requirements
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Step numbering is not increasing here and below.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are you sure you're not confused? As you can see in my branch, it does: https://github.com/AnonymousWP/spiderfoot/tree/Improve-readme#stable-build-packaged-release. Maybe you think it should increase the number, but some actions (e.g. "Docker stable build (packaged release)" for example) have only one step to be followed. Because of the small header, it's unclear it's about a new step maybe. That's why I also recommend starting with H1 -> H2 -> H3, etc.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@smicallef smicallef smicallef left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@AnonymousWP @smicallef