From 5f907d55aaa5943aee780f7804907140bf877106 Mon Sep 17 00:00:00 2001 From: Josh Suereth Date: Fri, 5 Oct 2012 21:03:23 -0300 Subject: [PATCH] Update src/sphinx/Getting-Started/Setup.rst Modify getting started guide download page to: * have correct links * highlight native packages, and community packages * include direct downloads of 0.12.1 bundles. --- src/sphinx/Getting-Started/Setup.rst | 39 ++++++++++++++++------------ src/sphinx/conf.py | 11 ++++++-- 2 files changed, 31 insertions(+), 19 deletions(-) diff --git a/src/sphinx/Getting-Started/Setup.rst b/src/sphinx/Getting-Started/Setup.rst index 534ceacd5..07f77b48b 100644 --- a/src/sphinx/Getting-Started/Setup.rst +++ b/src/sphinx/Getting-Started/Setup.rst @@ -21,8 +21,19 @@ To create an sbt project, you'll need to take these steps: Installing sbt ============== -You need two files: `sbt-launch.jar`_ and a script to run it. -The following sections describe how to accomplish this for different systems. +sbt comes pre-built with several available packages for different operating systems. + +Here's the available download packages: + - ZIP_ or TGZ_ packages + - MSI_ for Windows + - RPM_ or the Typesafe `Yum`_ repository + - DEB_ or the Typesafe `Apt`_ repository + - Homebrew or Macports for `Mac`_ + - `Gentoo`_ emerge overlays + +Please report any issues to the sbt-launcher-package_ project. + +You may also try out the `Manual Installation`_. Yum --- @@ -40,6 +51,8 @@ to grab the latest release of sbt. Please make sure to report any issues you may find to the |sbt-launcher-issues|_. + + Apt --- @@ -48,9 +61,10 @@ typesafe debian repository to your list of approved sources. Then run: .. code-block:: console + apt-get update apt-get install sbt -to grab the latest release of sbt. +to grab the latest typesafe stack release of sbt. If sbt cannot be found, dont forget to update your list of repositories. To do so, run: @@ -101,21 +115,11 @@ Or `HomeBrew `_: Please make sure to report any issues with these packages to the relevant maintainers. - -Windows MSI ------------ - -Download and run the `msi`_. -You should then be able to run ``sbt`` at the command prompt. - - -.. note:: - - Please make sure to report any issues to the |sbt-launcher-issues|_. - Manual Installation ------------------- +.. _manual installation: + Windows ~~~~~~~ @@ -126,13 +130,13 @@ Create a batch file ``sbt.bat``: $ set SCRIPT_DIR=%~dp0 $ java -Xmx512M -jar "%SCRIPT_DIR%sbt-launch.jar" %* -and put `sbt-launch.jar`_ in the same directory as the batch file. Put ``sbt.bat`` on your path so +and put sbt-launch.jar_ in the same directory as the batch file. Put ``sbt.bat`` on your path so that you can launch ``sbt`` in any directory by typing ``sbt`` at the command prompt. Unix ~~~~ -Download `sbt-launch.jar`_ and place it in ``~/bin``. +Download sbt-launch.jar_ and place it in ``~/bin``. Create a script to run the jar, by placing this in a file called ``sbt`` in your ``~/bin`` directory: @@ -173,4 +177,5 @@ Move on to :doc:`create a simple project `. .. _typesafe-debian-repo: http://apt.typesafe.com .. _this rpm: http://rpm.typesafe.com/typesafe-repo-2.0.0-1.noarch.rpm .. _this deb: http://apt.typesafe.com/repo-deb-build-0002.deb +.. _sbt-launcher-package: https://github.com/sbt/sbt-launcher-package/issues diff --git a/src/sphinx/conf.py b/src/sphinx/conf.py index e6526ecf3..b6123f56e 100644 --- a/src/sphinx/conf.py +++ b/src/sphinx/conf.py @@ -46,13 +46,18 @@ typesafe_ivy_snapshots = typesafe_base + 'ivy-snapshots/' typesafe_ivy_releases = typesafe_base + 'ivy-releases/' launcher_release_base = typesafe_ivy_releases + 'org.scala-sbt/sbt-launch/' launcher_snapshots_base = typesafe_ivy_snapshots + 'org.scala-sbt/sbt-launch/' +sbt_native_package_base = 'http://scalasbt.artifactoryonline.com/scalasbt/sbt-native-packages/org/scala-sbt/sbt/' rst_epilog = """ .. _typesafe-snapshots: %(typesafe_ivy_snapshots)s .. |typesafe-snapshots| replace:: Typesafe Snapshots .. _sbt-launch.jar: %(launcher_release_base)s/%(version)s/sbt-launch.jar -.. _msi: %(launcher_release_base)s/%(version)s/sbt.msi +.. _MSI: %(sbt_native_package_base)s/%(version)s/sbt.msi +.. _TGZ: %(sbt_native_package_base)s/%(version)s/sbt.tgz +.. _ZIP: %(sbt_native_package_base)s/%(version)s/sbt.zip +.. _DEB: %(sbt_native_package_base)s/%(version)s/sbt.deb +.. _RPM: %(sbt_native_package_base)s/%(version)s/sbt.rpm .. |nightly-launcher| replace:: <%(launcher_snapshots_base)s .. _mailing list: http://groups.google.com/group/simple-build-tool/topics .. _source code: http://github.com/harrah/xsbt @@ -60,5 +65,7 @@ rst_epilog = """ 'launcher_release_base': launcher_release_base, 'launcher_snapshots_base': launcher_snapshots_base, 'version': release, - 'typesafe_ivy_snapshots': typesafe_ivy_snapshots + 'typesafe_ivy_snapshots': typesafe_ivy_snapshots, + 'sbt_native_package_base': sbt_native_package_base } +