diff --git a/docs/source/faq.rst b/docs/source/faq.rst new file mode 100644 index 000000000..d8cb8cae5 --- /dev/null +++ b/docs/source/faq.rst @@ -0,0 +1,44 @@ +.. _faq: + +Frequently Asked Questions +========================== + +Where is the best place to get help with OpenFPGA? +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Currently, we have an active github issues page found `here `_. Users can see if their +questions have already been answered by searching the open or closed issues, and users are recommended to post questions there first. +Asking questions on the github issues page allows us to answer the question for everyone who may be experiencing similar problems as +well. + +What should I do if verification fails when first installing OpenFPGA? +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +First, check to make sure all dependencies for OpenFPGA have been installed and are up-to-date on the desired device. To see the full +list of depenencies, please visit +`our github dependencies page `_. +This issue has been discussed `in issue 280 `_. + + +Can I test multiple script parameters for a single variable? +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Testing multiple script parameters for a variable is possible by modifying the task.conf file. Doing so will create a job for +each combination of the variables. A solution is discussed `in issue 228 `_. + + +How do I setup OpenFPGA to be used by multiple users on a single device? +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +OpenFPGA can support multiple users on a shared device using the environment variable ``OPENFPGA_ROOT``. The OpenFPGA script for +running tasks needs ``OPENFPGA_ROOT`` to be the path to the OpenFPGA root directory. Users can then run the script on a task in the +current working directory. A solution is discussed `in issue 209 `_. + + +Which branch should I work on to contribute to OpenFPGA? +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Users of OpenFPGA that are interested in contributing can select any `github branch `_ +that relates to the changes the user is interested in making. They can then submit a pull request to have their +changes implemented into OpenFPGA after passing the CI/CD tests. +