Skip to content

Commit afe4202

Browse files
committed
update docs in ReadMe
1 parent 3612df7 commit afe4202

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,15 @@
11
# katana
2-
An advanced yet simple attack/defence CTF infrastructure in Go
2+
An advanced yet simple attack/defence CTF infrastructure in Go build upon k8s.
33

44
## Setup
55
- To start, you must have the following installed:
66
- Go 1.18+
77
- Minikube & kubectl
88
- Run `make set-env` to setup the environment
99
- To start katana, run `./bin/katana run`
10+
11+
## Docs
12+
- To get the most stable docs :
13+
- Setup docs locally by running `make setup-docs` followed by `hugo serve` from the `docs` directory.
14+
- The docs are also available at [https://blog.sdslabs.co/katana](https://blog.sdslabs.co/katana/Katana/getting-started/).
15+
- To visit the most updated docs, it's advised to setup the docs locally from the docs branch.

0 commit comments

Comments
 (0)