amp/docs/README.md

# Documentation

This directory contains the documentation for `amphp/amp`. 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
```

```
bundle install --path vendor/bundle
bundle exec jekyll serve
```
Add intro README for the docs directory 2017-03-13 13:23:35 +01:00			`# Documentation`

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

Allow ./docs to be published as Jekyll page 2017-05-26 19:56:02 +02:00			`## Reading`
Remove already documented items from managing-concurrency.md Merged a small part into the initial docs/README.md, most parts were already documented elsewhere. Generator docs might be helpful for building the coroutines documentation. 2017-05-03 13:12:42 +02:00
Allow ./docs to be published as Jekyll page 2017-05-26 19:56:02 +02:00			`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.`
Remove already documented items from managing-concurrency.md Merged a small part into the initial docs/README.md, most parts were already documented elsewhere. Generator docs might be helpful for building the coroutines documentation. 2017-05-03 13:12:42 +02:00
Allow ./docs to be published as Jekyll page 2017-05-26 19:56:02 +02:00			`## Writing`
Remove already documented items from managing-concurrency.md Merged a small part into the initial docs/README.md, most parts were already documented elsewhere. Generator docs might be helpful for building the coroutines documentation. 2017-05-03 13:12:42 +02:00
Allow ./docs to be published as Jekyll page 2017-05-26 19:56:02 +02:00			`Our documentation is built using Jekyll.`
Remove already documented items from managing-concurrency.md Merged a small part into the initial docs/README.md, most parts were already documented elsewhere. Generator docs might be helpful for building the coroutines documentation. 2017-05-03 13:12:42 +02:00
Allow ./docs to be published as Jekyll page 2017-05-26 19:56:02 +02:00			```
			`sudo gem install bundler jekyll`
			```

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