The first step is to install [Vitis/Vivado](https://www.xilinx.com/support/download.html) on your host machine's file system.
## Getting started
Currently, we are using version [2024.2](https://www.xilinx.com/support/download/index.html/content/xilinx/en/downloadNav/vivado-design-tools/2024-2.html).
To make it easy for you to get started with GitLab, here's a list of recommended next steps.
## Content of the Dockerfile
Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)!
Given that support is limited to a few Linux distributions, the docker is based on the file system of version 22.04 of the Ubuntu distribution.
## Add your files
The first step is to copy the installLibs.sh script to your new folder.
-[ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files
-[ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command:
The second step is to create the Dockerfile and fill it in.
-[ ] [Set up project integrations](https://gitedu.hesge.ch/cores/tools/docker-for-vivado/-/settings/integrations)
```sh
$ touch Dockerfile
$ <your_text_editor> Dockerfile
```
## Collaborate with your team
Please note, you have to modifiy `XILINXD_LICENSE_FILE` and `LM_LICENSE_FILE` environment variables.
-[ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/)
-[ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
-[ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
Use the built-in continuous integration in GitLab.
# Set environment variables to ensure non-interactive installs
ENV DEBIAN_FRONTEND=noninteractive
-[ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html)
-[ ] [Analyze your code for known vulnerabilities with Static Application Security Testing (SAST)](https://docs.gitlab.com/ee/user/application_security/sast/)
-[ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
-[ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/)
-[ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html)
# Update package lists and install necessary packages
RUN apt-get update && apt-get install -y \
wget \
curl \
unzip \
build-essential \
locales \
usbutils \
vim \
emacs \
libudev1 \
libudev-dev \
&& rm -rf /var/lib/apt/lists/*
***
# Generate the en_US.UTF-8 locale
RUN locale-gen en_US.UTF-8
# Editing this README
# Set the locale environment variables
ENV LANG=en_US.UTF-8 \
LC_ALL=en_US.UTF-8 \
LANGUAGE=en_US.UTF-8
When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thanks to [makeareadme.com](https://www.makeareadme.com/) for this template.
# Set LD_PRELOAD to automatically load the required libudev.so.1
ENV LD_PRELOAD=/lib/x86_64-linux-gnu/libudev.so.1
## Suggestions for a good README
# Create the required directory (if needed) and copy your script or other necessary files
# Assuming the installLibs.sh script is available in the build context
COPY ./installLibs.sh /installLibs.sh
Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.
# Make sure the script is executable
RUN chmod +x /installLibs.sh
## Name
Choose a self-explaining name for your project.
# Run the installation script during the build process
RUN /installLibs.sh
## Description
Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
ENV XILINXD_LICENSE_FILE="2100@10.136.142.218"
ENV LM_LICENSE_FILE="2100@10.136.142.218"
## Badges
On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
# Make the script run automatically when the container starts
Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
## Building the Docker image
## Installation
Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
```sh
$ docker build -t my-ubuntu-vitis-image .
```
## Usage
Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
## Allow Docker to access X11 server
## Support
Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
The next command adds hostnames or user names to the list allowed to make connection to the X server.
## Roadmap
If you have ideas for releases in the future, it is a good idea to list them in the README.
```sh
$ xhost +local:docker
```
## Docker run command
1.`--privileged`: Grant the container additional privileges to access USB devices
2.`--device=/dev/ttyUSBX`: Expose USB device(s), adjust device name as needed
3.`--mount`: Mount folder
4.`-e DISPLAY=$DISPLAY`: Pass the `DISPLAY` variable to the container
5.`-v /tmp/.X11-unix:/tmp/.X11-unix`: Share the X11 socket with the container
State if you are open to contributions and what your requirements are for accepting them.
## Running Vivado
For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
```sh
$ vivado
```
You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
# Useful links
## Authors and acknowledgment
Show your appreciation to those who have contributed to the project.
## A collection of `.gitignore` files
## License
For open source projects, say how it is licensed.
The following github repository contains a collection of `.gitignore` files useful for various projets.
## Project status
If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.
