diff --git a/README.md b/README.md index f5ab619..1c8ba3b 100644 --- a/README.md +++ b/README.md @@ -33,7 +33,7 @@ The solution that Traveling Ruby advocates, is to distribute your app as a singl This makes the release process much simpler. Instead of having to create almost 10 packages using a fleet of VMs, you just create 3 packages quickly and easily from your developer laptop. These 3 packages cover all the major platforms that your end users are on: * Linux x86\_64. - * macOS. + * macOS - *This might also be referred to as OS X at points in this repo* * Windows. But see [the Windows-specific caveats](#caveats). However, distributing a precompiled Ruby interpreter that works for all end users, is more easily said than done. [Read this section](#why_precompiled_binary_difficult) to learn why it's difficult. @@ -72,7 +72,7 @@ There are also some real-world examples of how people used Traveling Ruby to pac Native extensions: - * Traveling Ruby only supports native extensions when creating Linux and OS X packages. Native extensions are currently not supported when creating Windows packages. + * Traveling Ruby only supports native extensions when creating Linux and macOS packages. Native extensions are currently not supported when creating Windows packages. * Traveling Ruby only supports a number of popular native extension gems, and only in some specific versions. You cannot use just any native extension gem. * Native extensions are covered in [tutorial 3](TUTORIAL-3.md). @@ -90,7 +90,7 @@ The Traveling Ruby project supplies binaries that application developers can use For the Linux build system, see [linux/README.md](linux/README.md). -For the macOS build system, see [osx/README.md](osx/README.md). +For the macOS build system, see [macOS/README.md](macOS/README.md). ## Future work diff --git a/TUTORIAL-1.md b/TUTORIAL-1.md index c5d2831..5e0e52e 100644 --- a/TUTORIAL-1.md +++ b/TUTORIAL-1.md @@ -1,6 +1,6 @@ # Tutorial 1: hello world -This tutorial teaches you, in 5 minutes, how to use Traveling Ruby to create self-contained packages of a hello world app. This app has no gem dependencies; dependency management is covered in [tutorial 2](TUTORIAL-2.md). We will be creating three packages, namely for Linux x86, Linux x86_64 and OS X. +This tutorial teaches you, in 5 minutes, how to use Traveling Ruby to create self-contained packages of a hello world app. This app has no gem dependencies; dependency management is covered in [tutorial 2](TUTORIAL-2.md). We will be creating three packages, namely for Linux x86, Linux x86_64 and macOS. This tutorial **does not cover Windows**. This tutorial [will not work on Windows](README.md#caveats); nor will this tutorial generate packages for Windows. The creation of packages for Windows is covered in [tutorial 4](TUTORIAL-4.md). @@ -85,7 +85,7 @@ Your directory structure will now look like this: ### Quick sanity testing -Let's do a basic sanity test by running your app with a bundled Ruby interpreter. Suppose that you are developing on OS X. Run this: +Let's do a basic sanity test by running your app with a bundled Ruby interpreter. Suppose that you are developing on macOS. Run this: ```Bash cd hello-1.0.0-osx @@ -174,7 +174,7 @@ namespace :package do end end - desc "Package your app for OS X" + desc "Package your app for osx" task :osx => "packaging/traveling-ruby-#{TRAVELING_RUBY_VERSION}-osx.tar.gz" do create_package("osx") end diff --git a/TUTORIAL-2.md b/TUTORIAL-2.md index 66c0e7a..5d25497 100644 --- a/TUTORIAL-2.md +++ b/TUTORIAL-2.md @@ -191,7 +191,7 @@ namespace :package do end end - desc "Package your app for OS X" + desc "Package your app for osx" task :osx => [:bundle_install, "packaging/traveling-ruby-#{TRAVELING_RUBY_VERSION}-osx.tar.gz"] do create_package("osx") end diff --git a/TUTORIAL-3.md b/TUTORIAL-3.md index 6a961df..63f0211 100644 --- a/TUTORIAL-3.md +++ b/TUTORIAL-3.md @@ -112,7 +112,7 @@ $ rm -rf hello-1.0.0-linux-x86_64 $ rm -rf hello-1.0.0-osx ``` -Now you can test whether it works. Suppose that you're developing on OS X. Extract the OS X package and test it: +Now you can test whether it works. Suppose that you're developing on macOS. Extract the macOS package and test it: ``` $ tar xzf hello-1.0.0-osx.tar.gz @@ -161,7 +161,7 @@ namespace :package do end end - desc "Package your app for OS X" + desc "Package your app for osx" task :osx => [:bundle_install, "packaging/traveling-ruby-#{TRAVELING_RUBY_VERSION}-osx.tar.gz", "packaging/traveling-ruby-#{TRAVELING_RUBY_VERSION}-osx-sqlite3-#{SQLITE3_VERSION}.tar.gz" diff --git a/TUTORIAL-4.md b/TUTORIAL-4.md index f1fb780..3707457 100644 --- a/TUTORIAL-4.md +++ b/TUTORIAL-4.md @@ -8,7 +8,7 @@ You can find the end result of this tutorial at https://github.com/phusion/trave ## Creating a batch file -Suppose that we want to create a Windows package for our hello world app from [tutorial 2](TUTORIAL-2.md). The first thing we need to create is a Windows wrapper script. We already have a Unix wrapper script in `packaging/wrapper.sh`, which works on Linux and OS X, but Windows doesn't support Unix shell scripts. For Windows we'll need to create a wrapper script in the DOS batch format. +Suppose that we want to create a Windows package for our hello world app from [tutorial 2](TUTORIAL-2.md). The first thing we need to create is a Windows wrapper script. We already have a Unix wrapper script in `packaging/wrapper.sh`, which works on Linux and macOS, but Windows doesn't support Unix shell scripts. For Windows we'll need to create a wrapper script in the DOS batch format. Create `packaging/wrapper.bat`: @@ -25,7 +25,7 @@ set BUNDLE_IGNORE_CONFIG= ## Modifying the Rakefile -The next step is to add a Rake task for creating the Windows package. The Rakefile currently generates tar.gz packages for Linux and OS X, but tar.gz is not a common format on Windows. For Windows, we'll want to create a .zip package instead. +The next step is to add a Rake task for creating the Windows package. The Rakefile currently generates tar.gz packages for Linux and macOS, but tar.gz is not a common format on Windows. For Windows, we'll want to create a .zip package instead. Add a `package:win32` task to your Rakefile: @@ -89,7 +89,7 @@ task :package => ['package:linux:x86', 'package:linux:x86_64', 'package:osx', 'p ## Creating and testing the package -Congratulations. The `rake package` command will now generate packages for Windows, Linux and OS X. But let's test the Windows package. Run the following command to generate a Windows package: +Congratulations. The `rake package` command will now generate packages for Windows, Linux and macOS. But let's test the Windows package. Run the following command to generate a Windows package: ```Bash rake package:win32 diff --git a/osx/README.md b/osx/README.md index 491e344..a55c82b 100644 --- a/osx/README.md +++ b/osx/README.md @@ -1,4 +1,4 @@ -# Traveling Ruby OS X build system +# Traveling Ruby macOS build system The build system requires the Developer Commandline Tools to be installed, as well as a number of other things. See the "System requirements" section. diff --git a/osx/build-ruby b/osx/build-ruby old mode 100755 new mode 100644 diff --git a/osx/internal/bin/c++ b/osx/internal/bin/c++ old mode 100755 new mode 100644 diff --git a/osx/internal/bin/cc b/osx/internal/bin/cc old mode 100755 new mode 100644 diff --git a/osx/internal/bin/clang b/osx/internal/bin/clang deleted file mode 120000 index 2652f5f..0000000 --- a/osx/internal/bin/clang +++ /dev/null @@ -1 +0,0 @@ -cc \ No newline at end of file diff --git a/osx/internal/bin/clang b/osx/internal/bin/clang new file mode 100644 index 0000000..2652f5f --- /dev/null +++ b/osx/internal/bin/clang @@ -0,0 +1 @@ +cc \ No newline at end of file diff --git a/osx/internal/bin/clang++ b/osx/internal/bin/clang++ deleted file mode 120000 index 5cce967..0000000 --- a/osx/internal/bin/clang++ +++ /dev/null @@ -1 +0,0 @@ -c++ \ No newline at end of file diff --git a/osx/internal/bin/clang++ b/osx/internal/bin/clang++ new file mode 100644 index 0000000..5cce967 --- /dev/null +++ b/osx/internal/bin/clang++ @@ -0,0 +1 @@ +c++ \ No newline at end of file diff --git a/osx/internal/check_requirements b/osx/internal/check_requirements old mode 100755 new mode 100644 diff --git a/osx/internal/sanity_check b/osx/internal/sanity_check old mode 100755 new mode 100644 diff --git a/osx/package b/osx/package old mode 100755 new mode 100644 diff --git a/osx/setup-runtime b/osx/setup-runtime old mode 100755 new mode 100644 diff --git a/osx/test-gems b/osx/test-gems old mode 100755 new mode 100644