====== RISC-V eXpress Install Manual ======
===== Overview =====
  This manual explains how to install RVX on a local machine
  using the RVX Mini Git repository.

===== Notice =====
All results produced using RVX are subject to the following conditions:
  * They must not be used beyond the predefined purpose and scope specified in advance for a particular class or research project.
  * They must not be distributed to third parties other than the designated users or organizations.
  * Prior approval and a technology transfer agreement are required for any commercial use.

When using the RVX server provided by ETRI:
    * Only the features available through RVX mini may be used.
    * The user is fully responsible for any incidents or damages, including financial costs, resulting from intentional misuse or violation of these terms.
   
===== Requirements =====
===License Tools===
  * RTL Simulator: Modelsim/Questa or Xcelium/NCSim/Incisive
  * FPGA Tool: Xilinx Vivado 2021.2 or later

===A High-Performance Computer===
  * A capable machine is required to run license tools efficiently.
  * The actual performance needed depends on the specific license tools being used.
  * Note: The RVX engine itself does not require a high-performance machine.

===Recommended OS Versions===
  * Must be compatible with license tools.\\
  * For Linux systems, the locale setting must be en_US.UTF-8.
  * RVX-compatible OS
    * CentOS 7, 8
    * Redhat 8, 9
    * Ubuntu 18, 19, 20, 22, 24
    * Windows 10 (Home, Enterprise)
    * Windows 11 Home   
===User Account===
  * Linux: Must have sudo privileges
  * Windows: Must have administrator rights
===RVX Mini Git Repository===
  * To be provided by the instructor or project supervisor
===RVX Server Information===
    * IP address, SSH port, account, password
    * Provided by the instructor or project supervisor
    * You will need at least one user account per computer used
===== Things to Know =====
  * Any part starting with # should be replaced or modified according to your environment.
  * On Linux, use the bash shell for command-line operations.
  * On Windows, use the Windows Power Shell for command-line operations.
  * [[skill:linux|Skills for Linux]]
  * [[skill:windows|Skills for Winddows]]

===== Installation - Step 1 =====
 
  * [[install-manual:step1|Step 1]]

===== Installation - Step 2 =====
  * [[install-manual:step2|Step 2]]

===== Installation - Step 3 =====
  * [[install-manual:step3|Step 3]]

===== Installation - Part 4 (License Programs) =====

Carefully install the license programs you intend to use by following their respective manuals.\\
Add the installation directory to the PATH environment variable.\\
On Windows, it may be added automatically.

===== Installation - Part 5=====
  * [[install-manual:sync|Synch with RVX Server]]

===== Miscellaneous =====
  * [[install-manual:misc|Misc]]