Skip to content

Commit

Permalink
Readme update (#11)
Browse files Browse the repository at this point in the history
* Readme update for instructions
  • Loading branch information
chamhayden authored Jun 8, 2019
1 parent 994d0d8 commit fbe8b03
Showing 1 changed file with 29 additions and 22 deletions.
51 changes: 29 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,38 +1,45 @@
# Option 1: Use our virtual machine (supported)
* Install virtualbox
* Install virtualbox (exact installation instructions depend on your OS)
* [Download our virtual machine](http://tiny.cc/comp6771vm) we've created for you. It has everything set up. Run it with virtualbox. The password is "comp6771".
* In virtualbox, file > import appliance > the file you downloaded. Make sure you set the CPU and RAM to something appropriate for your machine.
* Run `chmod a+x ~/.CLion2019.*/config/plugins/clwb/gdb/gdbserver`
* Restore [the settings](http://tiny.cc/comp6771clionsettings) (file > import settings)

# Option 2: Install the same configuration as the virtual machine (somewhat supported)
* [Create a jetbrains account](https://www.jetbrains.com/shop/eform/students) (username/password) for free to obtain a Clion license
* Modify the line starting with "url" in ~/Documents/6771/.git/config
```
#url = [email protected]:cs6771/comp6771 # Old
url = https://github.com/cs6771/comp6771 # New
```

# Option 2: Linux - Install the same configuration as the virtual machine (mostly supported)
We *may* help you with this, depending on how much work it is, or we may tell you to just use the VM.
`sudo apt install clang-format`

## Clion (optional, but recommended)
## Required Installations
* Install clang-format
* `sudo apt install clang-format`
* [Download and install bazel](https://docs.bazel.build/versions/master/install-ubuntu.html)
* Ensure that are using gcc version 8 (supporting C++17).

## Installing and configuring Clion (optional, but recommended)
We will be using clion during the lectures. Use a different IDE or editor if you prefer, but do so at your own risk.

Download and install clion from [jetbrains website](https://www.jetbrains.com/clion/download/). Sign up using your student email to get a free copy.

## Installing bazel
* [Download and install bazel](https://docs.bazel.build/versions/master/install-ubuntu.html)
* Install bazel plugin for clion
* Configure > plugins
* Install bazel, clang-tidy, and clang-format.
After that is complete:

* Open Clion
* Configure plugins
* Clion menu: Configure > plugins
* Install bazel, clang-tidy, and clang-format.
* Restart clion
* Settings > bazel settings > bazel binary > set location to your bazel you downloaded
* Configure Clion for Bazel
* Clion menu: Configure > settings > bazel settings > bazel binary
* Set location to your bazel you downloaded and installed (likely /usr/bin/bazel)
* Restore [my settings](http://tiny.cc/comp6771clionsettings)
* Clion menu: File > import settings
* Run `chmod a+x ~/.CLion2019.*/config/plugins/clwb/gdb/gdbserver`
* Restore [my settings](http://tiny.cc/comp6771clionsettings) (file > import settings)


## C++ Compiler
Should be preinstalled. Version should be gcc 8. Needs to support C++17.

# Importing the project
* File > import bazel project > course repository

Things you may want to modify on the VM:
* Enable ideavim
* Import your project:
* Clion menu: File > import bazel project > course repository

# Option 3 (completely unsupported)

Expand Down

0 comments on commit fbe8b03

Please sign in to comment.