Skip to content

Commit

Permalink
docs: Edit README & CONTRIBUTING
Browse files Browse the repository at this point in the history
Signed-off-by: Hugo Hamet <hugo.hamet@proton.me>
  • Loading branch information
hop3calypse committed Jul 25, 2024
1 parent 85b9e07 commit acf70a8
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 21 deletions.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Contributing to [PROJECT'S NAME]
# Contributing to the Pentesting box database ?

## Create an issue

Expand Down
36 changes: 16 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,41 +1,37 @@
> If you see this section, you've just created a repository using [PoC Innovation's Open-Source project template](https://github.com/PoCInnovation/open-source-project-template). Check the [getting started guide](./.github/getting-started.md).
# πŸ”‘ Cybersecurity box database

# [PROJECT'S NAME]

[Project's description]
This repository aims to **store** every training box that was created by PoC's cybersecurity team (wheter it be on [TryHackMe](https://tryhackme.com), [HackTheBox](https://app.hackthebox.com), or any other third-party service -even [Pathwar](https://github.com/pathwar/pathwar)!).

## How does it work?

[Explain how this project is working]

## Getting Started

### Installation
Each box is filed in the appropriate website folder: for example, you can browse TryHackme boxes in the [TryHackMe folder](./TryHackMe/). The boxes still in development are -you guessed it- in the [indev folder](./indev/).

[Explain how to install all of the project's dependencies]
> [!WARNING]
> It is not useful nor recommended to download the whole repository. You're more likely to only need a specific box, and you can do so using the [download-directory](https://download-directory.github.io/) website.
### Quickstart
### Usage

[Explain how to run this project]
Since each box structure can be fundamentally different from one another, from virtual machines to a simple trivia, they all have *at least* two READMEs in their directory:

### Usage
- An explanation on how to get the box working. If the box has been published on a website, a link to its page will be provided.
- A write-up of the box. If there are multiple, there will be a folder named "write-ups" or something similar.

[Explain how to use this project]
If a box does not meet these requirements, you may want to file an **issue**. But before that, make sure to check out the next section.

## Get involved

You're invited to join this project ! Check out the [contributing guide](./CONTRIBUTING.md).
You're invited to join this project! Adding boxes, write-ups or requesting subjects ideas is greatly appreciated. Check out the [contributing guide](./CONTRIBUTING.md) before filing any issue or pull request.

If you're interested in how the project is organized at a higher level, please contact the current project manager.

## Our PoC team ❀️
## Our team πŸ‘Ύ

Developers
| [<img src="https://github.com/MrZalTy.png?size=85" width=85><br><sub>[Developer's name]</sub>](https://github.com/MrZalTy) | [<img src="https://github.com/MrZalTy.png?size=85" width=85><br><sub>[Developer's name]</sub>](https://github.com/MrZalTy) | [<img src="https://github.com/MrZalTy.png?size=85" width=85><br><sub>[Developer's name]</sub>](https://github.com/MrZalTy)
| :---: | :---: | :---: |
| [<img src="https://github.com/nl1x.png?size=85" width=85><br><sub>Nathan JEANNOT</sub>](https://github.com/nl1x) | [<img src="https://github.com/hugo-hamet.png?size=85" width=85><br><sub>Hugo HAMET</sub>](https://github.com/hugo-hamet)
| :---: | :---: |

Manager
| [<img src="https://github.com/adrienfort.png?size=85" width=85><br><sub>[Manager's name]</sub>](https://github.com/adrienfort)
| [<img src="https://github.com/thomas-pommier-epi.png?size=85" width=85><br><sub>Thomas POMMIER</sub>](https://github.com/thomas-pommier-epi)
| :---: |

<h2 align=center>
Expand Down Expand Up @@ -63,6 +59,6 @@ Organization
</a>
</p>
> πŸš€ Don't hesitate to follow us on our different networks, and put a star 🌟 on `PoC's` repositories
> πŸš€ Don't hesitate to follow us on our different networks, and put a star 🌟 on PoC's repositories!
> Made with ❀️ by PoC

0 comments on commit acf70a8

Please sign in to comment.