diff --git a/.ci/book.sh b/.ci/book.sh index 4b86e43..fd317c8 100755 --- a/.ci/book.sh +++ b/.ci/book.sh @@ -19,7 +19,7 @@ fi # This builds the book in target/doc/guide. See https://github.com/rust-lang-nursery/mdBook/issues/698 mkdir -p ../target/doc -mdbook build -d ../target/doc/book +$HOME/.cargo/bin/mdbook build -d ../target/doc/book # Get the lastest tag across all branches # https://stackoverflow.com/a/7261049/3549270 diff --git a/README.md b/README.md index bb97ff4..7a4fb30 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,8 @@ OpenCTF [![](https://travis-ci.org/easyctf/openctf.svg?branch=develop)](https://travis-ci.org/easyctf/openctf) ![](https://tokei.rs/b1/github/easyctf/openctf) +[Documentation](http://easyctf.github.io/openctf/) + OpenCTF is a framework for running CTF (capture-the-flag) competitions. The name OpenCTF comes from the platform used to run EasyCTF, but has since been [rewritten into Rust](https://github.com/ansuz/RIIR). As such, it's made with performance in mind, while also aiming to be as flexible as possible. Status @@ -11,6 +13,20 @@ Status OpenCTF is currently under development. Expect to see changes in the coming weeks! +Features +-------- + +- The entire platform ships in a _single_ binary! + - Easy installation by following instructions + - Flexible deployment options +- Individual user accounts + - Team formation through join codes + +Roadmap +------- + +See the [milestone](https://github.com/easyctf/openctf/milestone/3) for the 1.0 release for the roadmap. + Contact -------