Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
robinvanloonOWASP committed Oct 13, 2024
1 parent 686a99b commit 773de69
Showing 1 changed file with 15 additions and 1 deletion.
16 changes: 15 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,15 @@
# Security-Champions
# OWASP Security Champions Guide
Using MKDocs to host our content (next to the OWASP project page) on https://securitychampions.owasp.org/.
Inspired by https://github.com/OWASP/API-Security and https://github.com/OWASP/Top10/tree/master/2021.

## Building a local copy on Windows
Install python
python3 -m pip install -r requirements.txt
python3 -m pip install mkdocs

### Testing locally
python3 -m mkdocs serve to run website on http://127.0.0.1:8000/

or

python3 -m mkdocs build to generate site content for deployment

0 comments on commit 773de69

Please sign in to comment.