Merge pull request #509 from bmad-sim/external_deps_docs

External deps docs

.gitignore

@@ -14,6 +14,9 @@ xraylib/*
 gnu_utilities_src/*
 packages/*
 
+# Jupyter notebooks
+.ipynb_checkpoints
+
 bmad-doc/tutorial_bmad_tao/doc/2www.pl
 bmad-doc/tutorial_bmad_tao/doc/tutorial_bmad_tao.aux
 bmad-doc/tutorial_bmad_tao/doc/tutorial_bmad_tao.bbl
@@ -71,4 +74,4 @@ regression_tests/twiss_track_test/twiss.out
 
 *.digested*
 production
-debug
+debug

README.md

@@ -11,6 +11,33 @@ Two possibilities for setting up Bmad:
 Or if you want to compile Bmad directly:
 - Download a **Release** (click on link on right hand side of this page and download the **bmad_dist.tar.gz** file [Ignore the *source code* files.]) and follow the setup instructions at <https://wiki.classe.cornell.edu/ACC/ACL/OffsiteDoc>.
 
+
+## Developer Setup
+
+Developers should clone this repository, as well as its external dependencies:
+
+```bash
+git clone https://github.com/bmad-sim/bmad-ecosystem.git
+git clone https://github.com/bmad-sim/bmad-external-deps.git
+```
+
+The external dependencies repository is simply a set of compressed files. A simple bash script is provided to extract these into the `bmad-ecosystem`:
+```bash
+cd bmad-ecosystem
+bash util/extract_external_deps
+```
+
+To build everything:
+```bash
+cd bmad-ecosystem
+source util/dist_source_me
+util/dist_build_production
+```
+
+
+
+
+
 ## Contributing to Bmad: Pull Requests
 
 What is a Pull Request? A Pull Request (PR) is a mechanism for requesting that changes that you have made 

util/extract_external_deps

@@ -0,0 +1,7 @@
+#!/bin/bash
+DEPS=../bmad-external-deps/
+
+for dep in $DEPS/*.tar.gz;
+do
+tar xzvf $dep -C . 
+done