Skip to content

Commit

Permalink
docs: Make agnostic of repo to reuse snippets in occamy
Browse files Browse the repository at this point in the history
  • Loading branch information
colluca committed Sep 11, 2023
1 parent 369a630 commit 8c5cf9e
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 5 deletions.
4 changes: 4 additions & 0 deletions docs/publications.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

If you use the Snitch cluster or its extensions in your work, you can cite us:

<!--start-publications-->

<details>
<summary><b>Snitch: A tiny Pseudo Dual-Issue Processor for Area and Energy Efficient Execution of Floating-Point Intensive Workloads</b></summary>
<p>
Expand Down Expand Up @@ -95,3 +97,5 @@ If you use the Snitch cluster or its extensions in your work, you can cite us:
```

</p>

<!--end-publications-->
17 changes: 12 additions & 5 deletions docs/ug/getting_started.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
<!--start-section-1-->

# Getting Started

## Installation

Clone the repository:
```shell
git clone https://github.com/pulp-platform/snitch_cluster.git --recurse-submodules
git clone https://github.com/pulp-platform/{{ repo }}.git --recurse-submodules
```

If you had already cloned the repository without the `--recurse-submodules` flag, clone its submodules:
Expand All @@ -18,15 +20,17 @@ This repository requires several tools to be installed on your machine. Some of

Note that installing all tools, in appropriate versions, may be non-trivial. For this purpose, we provide a Docker container with all free tools installed.

The [following section](#docker-container) provides instructions to install the Docker container.
The [following section](https://pulp-platform.github.io/{{ repo }}/ug/getting_started.html#docker-container) provides instructions to install the Docker container.

Users with access to ETH Zurich IIS machines can find all tools already installed on these machines. To complete the setup, skip to the [IIS environment setup](#iis-environment-setup) section.
Users with access to ETH Zurich IIS machines can find all tools already installed on these machines. To complete the setup, skip to the [IIS environment setup](https://pulp-platform.github.io/{{ repo }}/ug/getting_started.html#iis-environment-setup) section.

If you do choose to setup a custom development environment on your own machine, we strongly recommend you take example from our [Docker file](https://github.com/pulp-platform/snitch_cluster/blob/{{ branch }}/util/container/README.md).
If you do choose to setup a custom development environment on your own machine, we strongly recommend you take example from our [Docker file](https://github.com/pulp-platform/{{ repo }}/blob/{{ branch }}/util/container/README.md).

## Docker container

The following instructions are extracted from the Docker container [README.md](https://github.com/pulp-platform/snitch_cluster/blob/{{ branch }}/util/container/README.md). For additional information on the Docker container refer to that document.
<!--end-section-1-->

The following instructions are extracted from the Docker container [README.md](https://github.com/pulp-platform/{{ repo }}/blob/{{ branch }}/util/container/README.md). For additional information on the Docker container refer to that document.

### Installation

Expand All @@ -38,6 +42,8 @@ The following instructions are extracted from the Docker container [README.md](h
heading-offset=1
%}

<!--start-section-2-->

## IIS environment setup

To make sure the right versions of each tool are picked up, set the following environment variables, e.g. in a bash shell:
Expand Down Expand Up @@ -74,3 +80,4 @@ Install the required packages in the currently active virtual environment:
```shell
pip install -r python-requirements.txt
```
<!--end-section-2-->
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ plugins:
- macros
use_directory_urls: false
extra:
repo: snitch_cluster
branch: main
nav:
- Home: index.md
Expand Down

0 comments on commit 8c5cf9e

Please sign in to comment.