Commit c36da216 authored by Davide Cieri's avatar Davide Cieri
Browse files

Add disclaimer to 2020.1 documentation

parent 31a02fa7
Loading
Loading
Loading
Loading
+3 −3
Original line number Diff line number Diff line
```{warning} Outdated Documentation!
    This documentation version is out of date. Please check the [latest version 2026.1](https://hog.readthedocs.io/en/latest/).
```
<!-- # Getting Started -->

# How to work with an existing Hog-handled repository
```{warning} Outdated Documentation!
    This documentation version is out of date. Please check the [latest version 2026.1](https://hog.readthedocs.io/en/latest/).
```

This section is intended for a developer that starts working with an existing HDL project that is managed with Hog.

+1 −1
Original line number Diff line number Diff line
## How to convert an existing project to Hog
```{warning} Outdated Documentation!
    This documentation version is out of date. Please check the [latest version 2026.1](https://hog.readthedocs.io/en/latest/).
```
## How to convert an existing project to Hog

Converting an existing project to Hog means: copying the source files into a git repository, adding Hog as a submodule, creating the Hog list files (text files containing the names of your source files), and creating a Tcl script able to create the Vivado/Quartus project.

+1 −1
Original line number Diff line number Diff line
## How to update Hog to a new release
```{warning} Outdated Documentation!
    This documentation version is out of date. Please check the [latest version 2026.1](https://hog.readthedocs.io/en/latest/).
```
## How to update Hog to a new release

This guide will help you to Update Hog to the version you want. We assume you already have a repository handled with Hog that is hosted on Cern Gitlab.

+1 −1
Original line number Diff line number Diff line
# Hog general overview
```{warning} Outdated Documentation!
    This documentation version is out of date. Please check the [latest version 2026.1](https://hog.readthedocs.io/en/latest/).
```
# Hog general overview

In this section we will describe how a project is set-up using Hog locally and for the Continuous Integration (CI).
In this section  we will make no assumptions on the code you already have.
+1 −1
Original line number Diff line number Diff line
# Hog Local
```{warning} Outdated Documentation!
    This documentation version is out of date. Please check the [latest version 2026.1](https://hog.readthedocs.io/en/latest/).
```
# Hog Local

```{toctree}
:glob:
Loading