Differences

This shows you the differences between two versions of the page.

--- download:sac2c [2018/06/25 14:48] – hnv
+++ download:sac2c [2022/02/03 10:55] – sbs
@@ Line 1: / Line 1: @@
-===== 1 Compiler: the sac2c ecosystem =====
+==== Installing the sac2c Eco System ====
-==== Major Release ====
+To get started, you need to install the compiler ''sac2c'' and the standard library ''Stdlib''. Both of them can either be installed via a precompiled package or from sources.
-The following packages contain the latest //major-number// release of ''sac2c''.
+=== Installation via packages ===
-<callout type="info" icon="true">
+Please choose the package that matches your operating system best:
-=== Package Compatibility ===
-Releases have been tested on specific operating system versions. Though some packages can be installed on newer or older systems, we advise against doing this. If you find a problem, please contact us (see at bottom of page of how to do this).
-The packages below have been build against the following libraries **which need to be available on the system** in order to install the compiler:
-  - CUDA 8.0
-  - HWLOC
-</callout>
-{{filelist>packages/release/sac*&style=page&recursive=1&sort=name&direct=1&showdate=0&showsize=1}}
-=== Extra ===
-We also have some //user-contributed// packages --- as these are packages outwith the project, we can not provide any support on these. Please communicate with the package maintainers.
-{{tablelayout?colwidth=","}}
-^ OS ^ External Link ^
-| ArchLinux | via [[https://aur.archlinux.org/packages/sac2c|AUR]] |
-==== Weeklies --- Bleeding-Edge Release ====
-<callout type="warning" icon="true">
-=== Stability ===
-These packages are of the most recent (//bleeding-edge//) state of the compiler. They are provided on a //best-effort// basis, but it is highly likely that the packages (and compiler) might not work correctly and negatively impact your system. You have been warned!
-</callout>
-{{filelist>packages/weekly/sac*&style=page&recursive=1&sort=name&direct=1&showdate=0&showsize=1}}
-==== Installing ====
 <accordion>
-<panel type="default" title="RPM (RedHat Based distributions)">
+<panel type="default" title="RPM (RedHat Based distributions such as RedHat, CentOS, Fedora, ...)">
-The ''rpm'' release of the compiler is designed to be installed on RedHat based distributions of Linux (e.g. RedHat, CentOS, Fedora, etc.) using the ''rpm'' tool set.
+The ''rpm'' release of the compiler is designed to be installed on RedHat based distributions of Linux (e.g. RedHat, CentOS, Fedora, etc.) using the ''dnf'' or ''rpm'' tool set.
-Installation:
+Choose and download the appropriate [[bin|packages (sac2c & stdlib)]].
+Thereafter you can install them via:
+<code>
+$ sudo dnf install sac2c-VERSION-RELEASE.rpm
+$ sudo dnf install sac-stdlib-VERSION-RELEASE.rpm
+</code>
+or
 <code>
 $ sudo rpm --install sac2c-VERSION-RELEASE.rpm
+$ sudo rpm --install sac-stdlib-VERSION-RELEASE.rpm
 </code>
 </panel>
-<panel type="default" title="DEB (Debian based distributions)">
+<panel type="default" title="DEB (Debian based distributions such as Debian, Ubuntu, ...)">
-The ''deb'' package is meant to be installed on Debian based distributions (e.g. Debian, Ubuntu, etc.) using the ''dpkg'' tool set.
+The ''deb'' package is meant to be installed on Debian based distributions (e.g. Debian, Ubuntu, etc.) using the ''dpkg'' or the ''apt'' tool set.
-Installation:
+Choose and download the appropriate [[bin|packages (sac2c #and# stdlib)]].
+Thereafter you can install them via:
 <code>
-$ sudo dpkg --install sac-VERSION-RELEASE.deb
+$ sudo dpkg --install sac2c-VERSION-RELEASE.deb
+$ sudo dpkg --install sac-stdlib-VERSION-RELEASE.deb
+</code>
+or
+<code>
+$ sudo apt install sac2c-VERSION-RELEASE.deb
+$ sudo apt install sac-stdlib-VERSION-RELEASE.deb
 </code>
 </panel>
 <panel type="default" title="Pkg (Apple MacOS)">
 The ''pkg'' is an installer that will place the SaC files in the correct location on your system. Symbolic links to the SaC binaries are created in ''/usr/local/bin'' for your convenience.
-The SaC binaries are postfixed by their release type (production or debug), so there is a ''sac2c_p'' and ''sac2c_d'' respectively, ''sac2c'' is simply a link to ''sac2c_p''.
-Installation:
+Choose and download the appropriate [[bin|packages (sac2c #and# stdlib)]].
-  - Double click the downloaded ''pkg'' file
+Thereafter you can install them via:
+  - Double click the downloaded file sac2c-VERSION-RELEASE.pkg
   - A dialog box should appear that will guide you through the install process
   - Confirm that you agree with our license, and click //Install// to install SaC
-  - The binary ''sac2c_p'' should be in your ''PATH''
+  - The binaries ''sac2c'', ''sac2c_p'', and ''sac2c_s'' should be in your ''PATH''
+  - Repeat the procedure with the file sac-stdlib-VERSION-RELEASE.pkg
+NB: The SaC binaries are postfixed by their release type (production or debug), so there is a ''sac2c_p'' and ''sac2c_d'' respectively, ''sac2c'' is simply a link to ''sac2c_p''.
+</panel>
+<panel type="default" title="Windows 10">
+While we do not currently support a native Windows version, you can still use it through a virtualisation layer
+of your choosing. The easiest way to use ''sac2c'' on a Windows 10 system is to use Window's own virtualisation
+for Linux support, the Windows Subsystem for Linux (WSL).
+To do this, you have to do four things:
+  - You need to activate the developer mode of Windows. (Settings -> Update & Security -> For developers -> tick the Developer Mode)
+  - You need to activate the WSL. (Control Panel -> Programs -> Programs & Features -> Turn Features On & Off -> tick Windows Subsystem for Linux)
+  - Go to the Microsoft Store and choose a Linux Distribution of your choice, e.g, Ubuntu 18.04 LTS.
+Choose and download the [[bin|packages (sac2c #and# stdlib)]] that match your chosen Linux Distribution.
+Thereafter you can install them using that system's package manager (if in doubt, cf. the corresponding section above)!
+After that, you should have the sac system up and running!
 </panel>
 <panel type="default" title="TAR.GZ (Unix-like operating systems)">
@@ Line 79: / Line 85: @@
 </code>
 </panel>
 </accordion>
-==== Contribute? ====
+In case you run into any troubles installing, please get in touch via our [[:bugzilla|community]] channels!
-Interested in contributing to the project? You can do so in several ways, by either telling us about bugs or by contributing code to the project.
+=== Installation from sources ===
-=== Reporting bugs ===
+The sources are hosted on two ''git'' servers:
-Head over to the [[:bugzilla|community]] page and follow the guidelines there on how to submit a bug.
+<panel type="default" title="Building the Stdlib from sources">
+The standard library is hosted on [[https://github.com/sacbase]] within the [[https://github.com/sacbase/Stdlib|Stdlib]] repository. If you do have ''sac2c'' installed (either via a package or from source), you can find instructions on how to build the Stdlib in the [[https://github.com/SacBase/Stdlib/blob/master/README.md|README]]. Contributions via pull-requests are always welcome!
+</panel>
+<panel type="default" title="Building sac2c from sources">
+The compiler is hosted on [[https://gitlab.sac-home.org]] within the [[https://gitlab.sac-home.org/sac-group/sac2c|sac-group/sac2c]] repository. As for ''github.com'', you need to create an account on ''gitlab.sac-home.org'' as well.
+Build instructions can be found there in the [[https://gitlab.sac-home.org/sac-group/sac2c/-/blob/develop/README.md|README]] as well. However, we have some more details in the internal section of this dokuwiki.
+To get access to those parts, you need to register on our dokuwiki as well. You can do so [[:index?do=register|here]].
+Contributions via pull-requests here are also always welcome!
+</panel>
-=== Contributing code ===
-  * Create an account on this site by [[:index?do=register|registering]],
-  * and send an email to [[info@sac-home.org]] indicating that you'd like to have access to the compiler sources.