3X supports OS X (Mac), Linux, and other standard Unix systems, but does not work on Windows. To use the GUI (graphical user interface), you need a modern web browser, such as Safari, Chrome, or Firefox. 3X is packaged as a single self-contained, executable file, so installation is basically a matter of downloading and copying one file to a special location on your system.
Latest release of 3X on GitHub contains prebuilt binaries for common environments.
You must download the correct file for your operating system and processor architecture: Darwin is for OS X and Linux is for Linux.
Downloading the right file for your system could be done automatically using the following series of commands:
release=v0.9
system=`uname -s`-`uname -m`
package=3x-$release-$system.sh
# download the correct binary from GitHub
curl -RLO https://github.com/netj/3x/releases/download/$release/$packageAfter you download the appropriate file, mark it as executable as shown in the following command, where $package is the path to the file you've just downloaded:
# make it an executable
chmod +x $packageYou should move the executable package to a directory that is on your $PATH, and rename it to 3x to use 3X without typing the long path name every time.
For example, if you already have ~/bin/ on your $PATH, simply place the package under it by running commands similar to the following:
mkdir -p ~/bin
mv $package ~/bin/3xIf you don't have ~/bin on your $PATH yet, add the following line to your
.bash_profile and/or .bashrc.
PATH=~/bin:"$PATH"3X documents and instructions contain example commands that may not work correctly on other shells than bash.
Unless you are familiar enough with your own shell, please enter a new bash session by typing bash before using 3X.
You can build 3X from its source code on other Unix operating systems, or when you are having trouble running the prebuilt packages on your system.
As long as you have a not-too-old version of Git and other essential compiler and build tools installed on your system, commands similar to the following three lines will produce an executable file, named 3x-VERSION-OS-MACHINE.sh.
Here, VERSION is the version of 3X you are building, and OS and MACHINE are your operating system and processor architecture that the produced 3X executable can run on.
For example, to download the source code for version v0.9, and to build a 3X executable package, run:
git clone https://github.com/netj/3x.git --branch v0.9
cd 3x
make packageIf you want to install the built package from the source tree to ~/bin/, run this command:
make install PREFIX=~PREFIX can be changed to other locations such as /usr/local to install 3X to /usr/local/bin/, which may require administrative permissions.
In that case, install the built executable using the sudo command:
sudo install 3x-LATEST-*.sh /usr/local/bin/3xUnfortunately, 3X can only run on operating systems that support POSIX, and therefore is not available for Windows operating system. There is no plan to support Windows in the near-term future. Although not recommended, you might be able to run 3X with Cygwin or other POSIX emulation layers if you have completely no access to a proper POSIX machine.