From cb5c8f7c46cf2e0cbd87cf7247b99f8e09bffd9b Mon Sep 17 00:00:00 2001 From: tangxifan Date: Sun, 5 May 2024 16:27:30 -0700 Subject: [PATCH] [doc] update os and dep info --- docs/source/tutorials/getting_started/compile.rst | 9 ++++----- .../tutorials/getting_started/regtest_dependencies.sh | 2 +- .../getting_started/ubuntu20p04_dependencies.sh | 2 +- .../getting_started/ubuntu20p04_regtest_dependencies.sh | 1 + .../getting_started/ubuntu22p04_regtest_dependencies.sh | 1 + 5 files changed, 8 insertions(+), 7 deletions(-) create mode 120000 docs/source/tutorials/getting_started/ubuntu20p04_regtest_dependencies.sh create mode 120000 docs/source/tutorials/getting_started/ubuntu22p04_regtest_dependencies.sh diff --git a/docs/source/tutorials/getting_started/compile.rst b/docs/source/tutorials/getting_started/compile.rst index 1a1cc89c0..fe7f0b5d6 100644 --- a/docs/source/tutorials/getting_started/compile.rst +++ b/docs/source/tutorials/getting_started/compile.rst @@ -12,7 +12,7 @@ How to Compile Supported Operating Systems ~~~~~~~~~~~~~~~~~~~~~~~~~~~ -OpenFPGA is continously tested with Ubuntu 20.04 and partially on Ubuntu 22.04 +OpenFPGA is continously tested with Ubuntu 22.04 and partially on Ubuntu 20.04 It might work with earlier versions and other distributions. In addition to continous integration, our community users have tested OpenFPGA on their local machines using the following operating systems: @@ -21,7 +21,6 @@ In addition to continous integration, our community users have tested OpenFPGA o - CentOS 8 - Ubuntu 18.04 - Ubuntu 21.04 -- Ubuntu 22.04 Build Steps ~~~~~~~~~~~ @@ -34,7 +33,7 @@ In general, please follow the steps to compile cd OpenFPGA make all -.. note:: OpenFPGA requires gcc/g++ version > 7 and clang version > 6. +.. note:: OpenFPGA requires gcc/g++ version > 9 and clang version > 10. .. note:: cmake3.12+ is recommended to compile OpenFPGA with GUI @@ -111,7 +110,7 @@ Ubuntu 20.04 - Dependencies required to run regression tests -.. include:: regtest_dependencies.sh +.. include:: ubuntu20p04_regtest_dependencies.sh :code: shell .. note:: Python packages are also required @@ -135,7 +134,7 @@ Ubuntu 22.04 - Dependencies required to run regression tests -.. include:: regtest_dependencies.sh +.. include:: ubuntu22p04_regtest_dependencies.sh :code: shell .. note:: Python packages are also required diff --git a/docs/source/tutorials/getting_started/regtest_dependencies.sh b/docs/source/tutorials/getting_started/regtest_dependencies.sh index 39fb7c71f..9454e026f 120000 --- a/docs/source/tutorials/getting_started/regtest_dependencies.sh +++ b/docs/source/tutorials/getting_started/regtest_dependencies.sh @@ -1 +1 @@ -../../../../.github/workflows/install_dependencies_run.sh \ No newline at end of file +../../../../.github/workflows/install_dependencies_run_ubuntu22p04.sh \ No newline at end of file diff --git a/docs/source/tutorials/getting_started/ubuntu20p04_dependencies.sh b/docs/source/tutorials/getting_started/ubuntu20p04_dependencies.sh index 326a04511..b5c829840 120000 --- a/docs/source/tutorials/getting_started/ubuntu20p04_dependencies.sh +++ b/docs/source/tutorials/getting_started/ubuntu20p04_dependencies.sh @@ -1 +1 @@ -../../../../.github/workflows/install_dependencies_build.sh \ No newline at end of file +../../../../.github/workflows/install_dependencies_build_ubuntu20p04.sh \ No newline at end of file diff --git a/docs/source/tutorials/getting_started/ubuntu20p04_regtest_dependencies.sh b/docs/source/tutorials/getting_started/ubuntu20p04_regtest_dependencies.sh new file mode 120000 index 000000000..67a110927 --- /dev/null +++ b/docs/source/tutorials/getting_started/ubuntu20p04_regtest_dependencies.sh @@ -0,0 +1 @@ +../../../../.github/workflows/install_dependencies_run_ubuntu20p04.sh \ No newline at end of file diff --git a/docs/source/tutorials/getting_started/ubuntu22p04_regtest_dependencies.sh b/docs/source/tutorials/getting_started/ubuntu22p04_regtest_dependencies.sh new file mode 120000 index 000000000..9454e026f --- /dev/null +++ b/docs/source/tutorials/getting_started/ubuntu22p04_regtest_dependencies.sh @@ -0,0 +1 @@ +../../../../.github/workflows/install_dependencies_run_ubuntu22p04.sh \ No newline at end of file