Skip to content

Commit

Permalink
update docs in ReadMe
Browse files Browse the repository at this point in the history
  • Loading branch information
ashpect committed Sep 1, 2024
1 parent 3612df7 commit afe4202
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,15 @@
# katana
An advanced yet simple attack/defence CTF infrastructure in Go
An advanced yet simple attack/defence CTF infrastructure in Go build upon k8s.

## Setup
- To start, you must have the following installed:
- Go 1.18+
- Minikube & kubectl
- Run `make set-env` to setup the environment
- To start katana, run `./bin/katana run`

## Docs
- To get the most stable docs :
- Setup docs locally by running `make setup-docs` followed by `hugo serve` from the `docs` directory.
- The docs are also available at [https://blog.sdslabs.co/katana](https://blog.sdslabs.co/katana/Katana/getting-started/).
- To visit the most updated docs, it's advised to setup the docs locally from the docs branch.

0 comments on commit afe4202

Please sign in to comment.