Refactor the multi-host salt install page.
[arvados.git] / build / README
index b076f0bfd225ca2973b7582b4a066e9cb6d5065f..54d5ea404cdef205d3cd08ffabcdd6d78d775eb7 100644 (file)
@@ -1,30 +1,32 @@
-Welcome to Arvados!
+Scripts in this directory:
 
-This is the arvados-dev source tree. It contains scripts that can be useful
-if you want to hack on Arvados itself.
+run-tests.sh                             Run unit and integration test suite.
 
-If you are interested in using Arvados or setting up your own Arvados
-installation, you most likely do not need this source tree.
+run-build-test-packages-one-target.sh    Entry point, wraps
+                                         run-build-packages-one-target.sh to
+                                         perform package building and testing
+                                         inside Docker.
 
-For the Arvados source code, check out the git repository at
-  https://github.com/curoverse/arvados
+run-build-packages-one-target.sh         Build packages for one target inside Docker.
 
-The main Arvados web site is 
-  https://arvados.org
+run-build-packages-all-targets.sh        Run run-build-packages-one-target.sh
+                                         for every target.
 
-The Arvados public wiki is located at 
-  https://arvados.org/projects/arvados/wiki
+run-build-packages.sh                    Actually build packages.  Intended to run
+                                         inside Docker container with proper
+                                         build environment.
 
-The Arvados public bug tracker is located at 
-  https://arvados.org/projects/arvados/issues
+run-build-packages-python-and-ruby.sh    Build Python and Ruby packages suitable
+                                         for upload to PyPi and Rubygems.
 
-For support see 
-  http://doc.arvados.org/user/getting_started/community.html
+run-build-docker-images.sh               Build arvbox Docker images.
 
-Installation documentation is located at 
-  http://doc.arvados.org/install
+run-build-docker-jobs-image.sh           Build arvados/jobs Docker image
+                                         (uses published debian packages)
 
-If you wish to build the documentation yourself, follow the instructions in
-doc/README to build the documentation, then consult the "Install Guide".
+build-dev-docker-jobs-image.sh           Build developer arvados/jobs Docker image
+                                         (uses local git tree)
 
-See COPYING for information about Arvados Free Software licenses.
+run-library.sh                           A library of functions shared by the
+                                         various scripts in this
+                                         directory.