Atrus7 / CSCE315-Project3

Eugenics-System

A system designed to generate a visualize a circuit generation algorithm. Consists of the engine server and visualization client.

Christopher Findeisen & Sam Gwydir & Jerego Orlino & Vincent Valenti

---

Development Notes

Directories

• eugenics := Eugenics Engine Server source code

• lookingglass := LookingGlass Circuit Visualizer source code

• eugenics-system := eugenics-system build files

Branches

• Main Branches

  • master := latest compiling code
  • develop := latest code, compiling or not. Default branch.

• Other Branches

  • feature/name := feature branch, merged into develop. note feature/ is a prefix. (e.g. feature/add-logging)
  • experimental/ := a contributors experimental branch.

Production Notes

Building

Dependencies

• gflags 2.1.1
• cmake
• FLTK (not yet)

Linux

Use your package manager to install cmake.

If building on Linux, share/scripts/install-gflags.sh will install gflags into $PROJECT_ROOT/local.

cd $PROJECT_ROOT;
./share/scripts/install-gflags.sh

OS X

If you have homebrew installed:

brew install cmake
brew install https://raw.githubusercontent.com/Gwydir8/Eugenics/develop/share/scripts/gflags.rb

If you don't have homebrew installed:

echo "Come back when you do!"

Manual Build

• note this builds the release build by default.
• run cmake -DCMAKE_BUILD_TYPE=Debug .. in build to build debug build
• run cmake -DCMAKE_BUILD_TYPE=Release .. in build to build release build explicitly

mkdir build
cd build
cmake ..

Automated Build

• PROJECT_ROOT is where you cloned the repository.

cd $PROJECT_ROOT;
./build.sh
# release binary will be build/eugenics-system/{eugenics, lookingglass}
# debug binary will be debug/eugenics-system/{eugenics, lookingglass}

Help

man $PROJECT_ROOT/share/man/eugenics.1
man $PROJECT_ROOT/share/man/lookingglass.1

Team 15

• Christopher Findeisen

  • [e-mail]

• Sam Gwydir

  • [e-mail]

• Jerego Orlino

  • [e-mail]

• Vincent Valenti

  • [e-mail]

Links

• Project 3 Spec
• Gitter