byte-stream/docs/README.md

Documentation

This directory contains the documentation for amphp/byte-stream. Documentation and code are bundled within a single repository for easier maintenance. Additionally, this preserves the documentation for older versions.

Reading

You can read this documentation either directly on GitHub or on our website. While the website will always contain the latest version, viewing on GitHub also works with older versions.

Writing

Our documentation is built using Jekyll.

sudo gem install bundler jekyll

git submodule init
git submodule update

cd docs

bundle install --path vendor/bundle
bundle exec jekyll serve