diff --git a/annotations/README.md b/annotations/README.md index 0b676dbc3..be3578524 100644 --- a/annotations/README.md +++ b/annotations/README.md @@ -1,5 +1,5 @@ # Parallelizability Study & Annotation Language -Quick Jump: [Parallelizability](#main-parallelizability-classes) | [study](#parallelizability-study-of-commands-in-gnu--posix) | [example 1](#a-simple-example-chmod) | [example 1](#another-example-cut) | [howto](#how-to-annotate-a-command) | [issues](#Issues) +Quick Jump: [Parallelizability](#main-parallelizability-classes) | [study](#parallelizability-study-of-commands-in-gnu--posix) | [example 1](#a-simple-example-chmod) | [example 2](#another-example-cut) | [howto](#how-to-annotate-a-command) | [issues](#Issues) PaSh includes (i) a parallelizability study of commands in POSIX and GNU Coreutils, and diff --git a/docs/contributing/contrib.md b/docs/contributing/contrib.md index 975ac95ca..9b7b60582 100644 --- a/docs/contributing/contrib.md +++ b/docs/contributing/contrib.md @@ -55,6 +55,7 @@ docker cp A B # copy host<->container; A B can be `NN:/x/y/z` ``` Useful options for `docker run`: + * [Mount host storage](https://docs.docker.com/storage/bind-mounts/): `-v /HST:/IN/NN` * [Limit CPU/Mem](https://docs.docker.com/config/containers/resource_constraints/): `--cpus='.5' --mem=1g` * [Limit disk size](https://docs.docker.com/engine/reference/commandline/run/#set-storage-driver-options-per-container): `--storage-opt size=10G` @@ -107,6 +108,7 @@ wsl --set-default-version 2 ``` Install one of the Linux distributions on which PaSh has been tested from the Microsoft Store: + * [Ubuntu 18.04 LTS](https://www.microsoft.com/store/apps/9N9TNGVNDL3Q) * [Ubuntu 20.04 LTS](https://www.microsoft.com/store/apps/9n6svws3rx71) * [Debian GNU/Linux](https://www.microsoft.com/store/apps/9MSVKQC78PK6) diff --git a/docs/install/README.md b/docs/install/README.md index ba4802003..63192d5c9 100644 --- a/docs/install/README.md +++ b/docs/install/README.md @@ -10,7 +10,7 @@ If on other environments or prefer manual setup, there are essentially three ste Most scripts support a `--help` flag that documents their options. These three steps are described in detail below, depending on the environment. -Quick Jump: [Clone & Setup](#) | [Manual Setup](#) | [Docker Setup](#) | [Windows using WSL](#repo-structure) +Quick Jump: [Clone & Setup](#) | [Manual Setup](#manual-setup) | [Docker Setup](#docker-setup) | [Windows using WSL](#windows-using-wsl) : ### Clone & Setup diff --git a/docs/tutorial/tutorial.md b/docs/tutorial/tutorial.md index 28a28f57b..153ba8d36 100644 --- a/docs/tutorial/tutorial.md +++ b/docs/tutorial/tutorial.md @@ -176,6 +176,7 @@ These three components implement the contributions presented [in the EuroSys pap They are expected to be usable with minimal effort, through a few different installation means presented below. The auxiliary directories are: + * [docs](../../docs): Design documents, tutorials, installation instructions, etc. * [evaluation](../../evaluation): Shell pipelines and script used for the evaluation of `pash`. @@ -186,13 +187,16 @@ Academic [papers](../README.md#academic-papers--events) associated with PaSh off #### Useful Links Chat: -* [Discord Server](ttps://discord.com/channels/947328962739187753/) ([Invite](http://join.binpa.sh/)) + +* [Discord Server](https://discord.com/channels/947328962739187753/) ([Invite](http://join.binpa.sh/)) Mailing Lists: + * [Discussion](https://groups.google.com/g/pash-dev): Join this mailing list for discussing all things `pash` * [Commits](https://groups.google.com/g/pash-commits): Join this mailing list for commit notifications Development/contributions: + * Contribution guide: [docs/contrib](../../docs/contributing/contrib.md) * Continuous Integration Server: [http://ci.binpa.sh/](http://ci.binpa.sh/)