diff options
author | Benoit Foucher <benoit@zeroc.com> | 2019-10-11 12:08:11 +0200 |
---|---|---|
committer | Benoit Foucher <benoit@zeroc.com> | 2019-10-11 12:08:25 +0200 |
commit | f47df588b6824cb995c87818e4b495689fd42d55 (patch) | |
tree | b3adb7135df83fd97be32bf254ab7ca0d0fb8132 | |
parent | Fixed typos (diff) | |
download | ice-f47df588b6824cb995c87818e4b495689fd42d55.tar.bz2 ice-f47df588b6824cb995c87818e4b495689fd42d55.tar.xz ice-f47df588b6824cb995c87818e4b495689fd42d55.zip |
Minor fixes to documentation files
-rw-r--r-- | cpp/README.md | 105 | ||||
-rw-r--r-- | csharp/README.md | 85 | ||||
-rw-r--r-- | java-compat/README.md | 11 | ||||
-rw-r--r-- | java-compat/gradle.properties | 23 | ||||
-rw-r--r-- | java/README.md | 6 | ||||
-rw-r--r-- | java/gradle.properties | 23 | ||||
-rw-r--r-- | js/README.md | 16 | ||||
-rw-r--r-- | matlab/README.md | 11 | ||||
-rw-r--r-- | php/README.md | 17 | ||||
-rw-r--r-- | python/README.md | 2 | ||||
-rw-r--r-- | ruby/README.md | 9 | ||||
-rw-r--r-- | swift/README.md | 27 |
12 files changed, 185 insertions, 150 deletions
diff --git a/cpp/README.md b/cpp/README.md index 39364d7ae1f..3ce7aaad28f 100644 --- a/cpp/README.md +++ b/cpp/README.md @@ -259,8 +259,8 @@ environment variables: ### Build Using Visual Studio -Open the Visual Studio solution that corresponds to the Visual Studio version you -are using. +Open the Visual Studio solution that corresponds to the Visual Studio version +you are using. - For Visual Studio 2019 use [msbuild/ice.v142.sln](./msbuild/ice.v142.sln) - For Visual Studio 2017 use [msbuild/ice.v141.sln](./msbuild/ice.v141.sln) @@ -268,22 +268,24 @@ are using. - For Visual Studio 2013 use [msbuild/ice.v120.sln](./msbuild/ice.v120.sln) - For Visual Studio 2010 use [msbuild/ice.v100.sln](./msbuild/ice.v100.sln) -Restore the solution NuGet packages using the NuGet package manager, if the automatic -download of packages during build is not enabled. +Restore the solution NuGet packages using the NuGet package manager, if the +automatic download of packages during build is not enabled. -Using the configuration manager choose the platform and configuration you want to build. +Using the configuration manager choose the platform and configuration you want +to build. -The solution provide a project for each Ice component and each component can be built -separatelly. When you build a component its dependencies are built automatically. +The solution provide a project for each Ice component and each component can be +built separatelly. When you build a component its dependencies are built +automatically. -For Visual Studio 2019, Visual Studio 2017 and Visual Studio 2015, the solutions organize -the projects in two solution folders, C++11 and C++98, which correspond to the C++11 and -C++98 mappings. If you want to build all the C++11 mapping components, build the C++11 -solution folder; likewise if you want to build all the C++98 mapping components, build -the C++98 solution folder. +For Visual Studio 2019, Visual Studio 2017 and Visual Studio 2015, the solutions +organize the projects in two solution folders, C++11 and C++98, which correspond +to the C++11 and C++98 mappings. If you want to build all the C++11 mapping +components, build the C++11 solution folder; likewise if you want to build all +the C++98 mapping components, build the C++98 solution folder. -For Visual Studio 2013 and Visual Studio 2010. there is no separate solution folder because -only the C++98 mapping is supported with these compilers. +For Visual Studio 2013 and Visual Studio 2010. there is no separate solution +folder because only the C++98 mapping is supported with these compilers. The test suite is built using separate Visual Studio solutions: @@ -291,30 +293,34 @@ The test suite is built using separate Visual Studio solutions: - Ice Test Suite for Visual Studio 2010 [msbuild/ice.test.v100.sln](./msbuild/ice.test.v100.sln) - Ice OpenSSL Test Suite for Visual Studio 2019, Visual Studio 2017, Visual Studio 2015 and Visual Studio 2013 [msbuild/ice.openssl.test.sln](./msbuild/ice.openssl.test.sln) -The solution provides a separate project for each test component, the `Cpp11-Release` and `Cpp11-Debug` build -configurations are setup to use the C++11 mapping in release and debug mode respectively, and are only supported -with Visual Studio 2019, Visual Studio 2017 and Visual Studio 2015. The `Release` and `Debug` build configurations are setup to -use the C++98 mapping in release and debug mode respectively. +The solution provides a separate project for each test component, the +`Cpp11-Release` and `Cpp11-Debug` build configurations are setup to use the +C++11 mapping in release and debug mode respectively, and are only supported +with Visual Studio 2019, Visual Studio 2017 and Visual Studio 2015. The +`Release` and `Debug` build configurations are setup to use the C++98 mapping in +release and debug mode respectively. -The building of the test uses by default the local source build, and you must have built the Ice -source with the same platform and configuration than you are attemping to build the tests. +The building of the test uses by default the local source build, and you must +have built the Ice source with the same platform and configuration than you are +attemping to build the tests. -For example to build the `Cpp11-Release/x64` tests you must have built first the C++11 mapping -using `Release/x64`. +For example to build the `Cpp11-Release/x64` tests you must have built first the +C++11 mapping using `Release/x64`. -It is also possible to build the tests using a C++ binary distribution, to do that you must -set the `ICE_BIN_DIST` environment variable to `all` before starting Visual Studio. +It is also possible to build the tests using a C++ binary distribution, to do +that you must set the `ICE_BIN_DIST` environment variable to `all` before +starting Visual Studio. -Then launch Visual Studio and open the desired test solution, you must now use NuGet package -manager to restore the NuGet packages, and the build will use Ice NuGet packages instead of -your local source build. +Then launch Visual Studio and open the desired test solution, you must now use +NuGet package manager to restore the NuGet packages, and the build will use Ice +NuGet packages instead of your local source build. ## Building Ice for Universal Windows (UWP) ### Build Using MSBuild -The steps are the same as for Building Ice for Windows above, except you must also -use a `UWP` target. +The steps are the same as for Building Ice for Windows above, except you must +also use a `UWP` target. To build Ice for UWP: ``` @@ -333,26 +339,33 @@ msbuild msbuild\ice.proj /t:UWPBuild /p:ICE_BIN_DIST=all ### Build Using Visual Studio -Before building Ice for UWP using Visual Studio you must build the slice2cpp compiler -from the C++98 mapping, refer to [Building Ice for Windows](#building-ice-for-windows). +Before building Ice for UWP using Visual Studio you must build the slice2cpp +compiler from the C++98 mapping, refer to [Building Ice for +Windows](#building-ice-for-windows). -Using either Visual Studio 2017 or Visual Studio 2015, open the [msbuild/ice.uwp.sln](./msbuild/ice.uwp.sln) +Using either Visual Studio 2017 or Visual Studio 2015, open the +[msbuild/ice.uwp.sln](./msbuild/ice.uwp.sln) -Choose the platform and configuration you want to build using the configuration manager. +Choose the platform and configuration you want to build using the configuration +manager. -The solution provides a project for each Ice component and each component can be built -separately. When you build a component, its dependencies are built automatically. +The solution provides a project for each Ice component and each component can be +built separately. When you build a component, its dependencies are built +automatically. -The test suite is built using a separate Visual Studio solution [msbuild/ice.testuwp.sln](./msbuild/ice.testuwp.sln). -This solution includes a project for each test and a project for the UWP test controller -required to run the test suite. +The test suite is built using a separate Visual Studio solution +[msbuild/ice.testuwp.sln](./msbuild/ice.testuwp.sln). This solution includes a +project for each test and a project for the UWP test controller required to run +the test suite. -It is also possible to build the tests using a C++ binary distribution, to do that you must -set `ICE_BIN_DIST` environment variable to `all` before starting Visual Studio. +It is also possible to build the tests using a C++ binary distribution, to do +that you must set `ICE_BIN_DIST` environment variable to `all` before starting +Visual Studio. -Then launch Visual Studio and open the [msbuild/ice.testuwp.sln](./msbuild/ice.testuwp.sln) solution, -you must now use NuGet package manager to restore the NuGet packages, and the build will use -Ice NuGet packages instead of your local source build. +Then launch Visual Studio and open the +[msbuild/ice.testuwp.sln](./msbuild/ice.testuwp.sln) solution, you must now use +NuGet package manager to restore the NuGet packages, and the build will use Ice +NuGet packages instead of your local source build. ## Installing a C++ Source Build on AIX, Linux or macOS @@ -365,7 +378,8 @@ After installation, make sure that the `<prefix>/bin` directory is in your If you choose to not embed a `runpath` into executables at build time (see your build settings in `../config/Make.rules`) or did not create a symbolic link from the `runpath` directory to the installation directory, you also need to add the -library directory to your `LD_LIBRARY_PATH` (AIX, Linux) or `DYLD_LIBRARY_PATH` (macOS). +library directory to your `LD_LIBRARY_PATH` (AIX, Linux) or `DYLD_LIBRARY_PATH` +(macOS). On an AIX system: <prefix>/lib @@ -506,7 +520,8 @@ python allTests.py --config=xcodesdk --platform=iphoneos python allTests.py --config=cpp11-xcodesdk --platform=iphoneos ``` -All the test clients and servers run on the iOS device, not on your Mac computer. +All the test clients and servers run on the iOS device, not on your Mac +computer. ### Universal Windows diff --git a/csharp/README.md b/csharp/README.md index 03094e70205..173cb66bfaf 100644 --- a/csharp/README.md +++ b/csharp/README.md @@ -45,8 +45,8 @@ To build all Ice assemblies and the associated test suite, run: msbuild msbuild\ice.proj ``` -Upon completion, the Ice assemblies for the .NET Framework 4.5 and .NET Standard 2.0 -are placed in the `lib\net45` and `lib\netstandard2.0` folders respectively. +Upon completion, the Ice assemblies for the .NET Framework 4.5 and .NET Standard +2.0 are placed in the `lib\net45` and `lib\netstandard2.0` folders respectively. > Note: the assemblies for .NET Standard 2.0 are created only when you build with > Visual Studio 2017 or greater. @@ -56,38 +56,40 @@ You can skip the build of the test suite with the `BuildDist` target: msbuild msbuild\ice.proj /t:BuildDist ``` -The `Net45Build`, `Net45BuildDist`, `NetStandardBuild` and `NetStandardBuildDist` -targets allow you to build assemblies only for the .NET Framework 4.5 or .NET Standard 2.0, -with or without the test suite. +The `Net45Build`, `Net45BuildDist`, `NetStandardBuild` and +`NetStandardBuildDist` targets allow you to build assemblies only for the .NET +Framework 4.5 or .NET Standard 2.0, with or without the test suite. -The iceboxnet and test applications target `netcoreapp3.0` when using Visual Studio 2019 and -`netcoreapp2.1` when using Visual Studio 2017. You can change the target framework by setting -the `AppTargetFramework` property to a different Target Framework Monikers value, for example: +The iceboxnet and test applications target `netcoreapp3.0` when using Visual +Studio 2019 and `netcoreapp2.1` when using Visual Studio 2017. You can change +the target framework by setting the `AppTargetFramework` property to a different +Target Framework Moniker value, for example: ``` msbuild msbuild\ice.proj /p:"AppTargetFramework=net462" ``` -This builds the test programs for `net462`. The target frameworks you specify must -implement .NET Standard 2.0. +This builds the test programs for `net462`. The target frameworks you specify +must implement .NET Standard 2.0. #### Strong Name Signatures -You can add Strong Naming signatures to the Ice assemblies by setting the following -environment variables before building these assemblies: +You can add Strong Naming signatures to the Ice assemblies by setting the +following environment variables before building these assemblies: - `PUBLIC_KEYFILE` Identity public key used to delay sign the assembly - `KEYFILE` Identity full key pair used to sign the assembly -If only `PUBLIC_KEYFILE` is set, the assemblies are delay-signed during the build -and you must re-sign the assemblies later with the full identity key pair. +If only `PUBLIC_KEYFILE` is set, the assemblies are delay-signed during the +build and you must re-sign the assemblies later with the full identity key pair. If only `KEYFILE` is set, the assemblies are fully signed during the build using -KEYFILE. +`KEYFILE`. -If both `PUBLIC_KEYFILE` and `KEYFILE` are set, assemblies are delay-signed during -the build using `PUBLIC_KEYFILE` and re-signed after the build using `KEYFILE`. -This can be used for generating [Enhanced Strong Naming][6] signatures. +If both `PUBLIC_KEYFILE` and `KEYFILE` are set, assemblies are delay-signed +during the build using `PUBLIC_KEYFILE` and re-signed after the build using +`KEYFILE`. This can be used for generating [Enhanced Strong Naming][6] +signatures. *Strong Name Signatures can be generated only from Windows builds.* @@ -107,7 +109,8 @@ You can build only the test suite with this command: msbuild msbuild\ice.proj /p:ICE_BIN_DIST=all ``` -This build retrieves and installs the `zeroc.ice.net` NuGet package if necessary. +This build retrieves and installs the `zeroc.ice.net` NuGet package if +necessary. ## Building on Linux or macOS @@ -136,13 +139,13 @@ You can skip the build of the test suite with the `BuildDist` target: dotnet msbuild msbuild/ice.proj /t:BuildDist ``` -The iceboxnet and test applications target `netcoreapp3.0` when using .NET Core 3.0 SDK -and `netcoreapp2.1` when using .NET Core 2.1 S SDK. You can change the target framework -by setting the `AppTargetFramework` property to a different Target Framework Monikers -value, for example: +The iceboxnet and test applications target `netcoreapp3.0` when using .NET Core +3.0 SDK and `netcoreapp2.1` when using .NET Core 2.1 SDK. You can change the +target framework by setting the `AppTargetFramework` property to a different +Target Framework Moniker value, for example: ``` -msbuild msbuild\ice.proj /p:"AppTargetFramework=netcoreapp2.2" +dotnet msbuild msbuild/ice.proj /p:"AppTargetFramework=netcoreapp2.2" ``` ## Running the Tests @@ -163,14 +166,14 @@ If everything worked out, you should see lots of `ok` messages. In case of a failure, the tests abort with `failed`. On Windows, `allTests.py` executes by default the tests for .NET Framework 4.5. -In order to execute the tests with .NET Core framework add the `--dotnetcore` option. -For example: +In order to execute the tests with .NET Core framework add the `--dotnetcore` +option. For example: ``` python allTests.py --dotnetcore ``` -If you build the test against a different target framework you must use `--framework` option -with the corresponding target framework. +If you build the test against a different target framework you must use +`--framework` option with the corresponding target framework. For example to run test build against .NET Framework 4.6.2: ``` @@ -192,18 +195,19 @@ following command: msbuild msbuild\ice.proj /t:NuGetPack ``` -This creates `zeroc.ice.net\zeroc.ice.net.nupkg`. +This creates the `zeroc.ice.net` Nuget package in the `msbuild\zeroc.ice.net` +directory. > Note: The NuGet package always includes assemblies for the .NET Framework 4.5. > -> If you build with Visual Studio 2017 or Visual Studio 2019, the NuGet package also -> includes assemblies for .NET Standard 2.0. +> If you build with Visual Studio 2017 or Visual Studio 2019, the NuGet package +> also includes assemblies for .NET Standard 2.0. > -> If you build with Visual Studio 2019 the NuGet package include iceboxnet executables -> targeting .NET Framework 4.5, .NET Core 3.0 and .NET Core 2.1. +> If you build with Visual Studio 2019 the NuGet package include iceboxnet +> executables targeting .NET Framework 4.5, .NET Core 3.0 and .NET Core 2.1. > -> If you build with Visual Studio 2017 the NuGet package include iceboxnet executables -> targeting .NET Framework 4.5 and .NET Core 2.1. +> If you build with Visual Studio 2017 the NuGet package include iceboxnet +> executables targeting .NET Framework 4.5 and .NET Core 2.1. > ### Creating NuGet Packages on Linux or macOS @@ -212,10 +216,11 @@ To create a NuGet package, open a command prompt and run the following command: ``` -dotnet msbuild msbuild\ice.proj /t:NuGetPack +dotnet msbuild msbuild/ice.proj /t:NuGetPack ``` -This creates `zeroc.ice.net\zeroc.ice.net.nupkg`. +This creates the `zeroc.ice.net` Nuget package in the `msbuild/zeroc.ice.net` +directory. ## Building Ice for Xamarin Test Suite @@ -224,8 +229,8 @@ the Ice test suite as a Xamarin application that can be deployed on iOS, Android or UWP platforms. The Xamarin test suite uses the Ice assemblies for .NET Standard 2.0. either -from the source distribution or using the zeroc.ice.net NuGet package. If using -the assembles from the source distribution, they must be built before this +from the source distribution or using the `zeroc.ice.net` NuGet package. If +using the assembles from the source distribution, they must be built before this application. ### Building on Windows @@ -303,7 +308,7 @@ python allTests.py --android --controller-app --config Release --platform x64 python allTests.py --controller-app --config Release --platform iphonesimulator ``` -[1]: https://zeroc.com/distributions/ice +[1]: https://zeroc.com/downloads/ice [2]: https://blogs.msdn.microsoft.com/dotnet/2017/08/14/announcing-net-standard-2-0 [3]: https://doc.zeroc.com/ice/3.7/release-notes/supported-platforms-for-ice-3-7-3 [4]: https://dotnet.microsoft.com/download/dotnet-core/2.1 diff --git a/java-compat/README.md b/java-compat/README.md index 1dd37675b0d..5158c471e84 100644 --- a/java-compat/README.md +++ b/java-compat/README.md @@ -39,9 +39,10 @@ Make sure that the `javac` and `java` commands are present in your PATH. ### Gradle Ice for Java uses the [Gradle][3] build system, and includes the Gradle wrapper -in the distribution. You cannot build the Ice for Java source distribution without -an Internet connection. Gradle will download all required packages automatically -from Maven Central repository located at http://central.maven.org/maven2/ +in the distribution. You cannot build the Ice for Java source distribution +without an Internet connection. Gradle will download all required packages +automatically from Maven Central repository located at +http://central.maven.org/maven2/ ### Bzip2 Compression @@ -92,8 +93,8 @@ set CPP_CONFIGURATION=Debug The supported values for `CPP_PLATFORM` are `Win32` and `x64` and the supported values for `CPP_CONFIGURATION` are `Debug` and `Release`. -Before building Ice for Java, review the settings in the file `gradle.properties` -and edit as necessary. +Before building Ice for Java, review the settings in the file +`gradle.properties` and edit as necessary. To build Ice, all services, and tests, run diff --git a/java-compat/gradle.properties b/java-compat/gradle.properties index dbb5e8bf351..ec28f1d6bed 100644 --- a/java-compat/gradle.properties +++ b/java-compat/gradle.properties @@ -17,7 +17,8 @@ iceVersion = 3.7.3 prefix = // -// Used to set --release (with javac >=9) or -source/-target with older javac versions. +// Used to set --release (with javac >=9) or -source/-target with older javac +// versions. // targetJavaRelease = 7 @@ -28,14 +29,16 @@ targetJavaRelease = 7 debug = true // -// Set the version of the Ice Builder to use for building. It must be set to debian +// Set the version of the Ice Builder to use for building. It must be set to +// debian // when using the gradle-ice-builder-plugin package on Debian. // iceBuilderVersion = 1.4.7 // -// Set the builder artifact class path. It must be set to com.zeroc.gradle.ice-builder -// when using the gradle-ice-builder-plugin package. +// Set the builder artifact class path. It must be set to +// com.zeroc.gradle.ice-builder when using the gradle-ice-builder-plugin +// package. // iceBuilderClassPath = gradle.plugin.com.zeroc.gradle.ice-builder @@ -55,16 +58,16 @@ devRepo = // // -// The platform used by the C++ builds. Supported values are `x64` and `Win32`. -// This is required to locate the slice2java compiler in the platform-dependent -// directory. +// The platform used by the C++ builds. Supported values are `x64` and +// `Win32`. This is required to locate the slice2java compiler in the +// platform-dependent directory. // cppPlatform = // -// The configuration used by the C++ builds. Supported values are `Debug` and `Release`. -// This is required to locate the slice2java compiler in the configuration-dependent -// directory. +// The configuration used by the C++ builds. Supported values are `Debug` +// and `Release`. This is required to locate the slice2java compiler in +// the configuration-dependent directory. // cppConfiguration = diff --git a/java/README.md b/java/README.md index c67a4b30b5b..e6eaadaff85 100644 --- a/java/README.md +++ b/java/README.md @@ -140,8 +140,8 @@ set CPP_CONFIGURATION=Debug The supported values for `CPP_PLATFORM` are `Win32` and `x64` and the supported values for `CPP_CONFIGURATION` are `Debug` and `Release`. -Before building Ice for Java, review the settings in the file `gradle.properties` -and edit as necessary. +Before building Ice for Java, review the settings in the file +`gradle.properties` and edit as necessary. To build Ice, all services, and tests, run ``` @@ -304,7 +304,7 @@ On macOS, the build also creates an application bundle named IceGrid GUI. You can start the IceGrid GUI tool by double-clicking the IceGrid GUI icon in Finder. -[1]: https://zeroc.com/distributions/ice +[1]: https://zeroc.com/downloads/ice [2]: https://doc.zeroc.com/ice/3.7/release-notes/supported-platforms-for-ice-3-7-3 [3]: https://gradle.org [4]: http://proguard.sourceforge.net diff --git a/java/gradle.properties b/java/gradle.properties index 5d66b49dd27..56ef44b441d 100644 --- a/java/gradle.properties +++ b/java/gradle.properties @@ -17,7 +17,8 @@ iceVersion = 3.7.3 prefix = // -// Used to set --release (with javac >=9) or -source/-target with older javac versions. +// Used to set --release (with javac >=9) or -source/-target with older javac +// versions. // targetJavaRelease = 8 @@ -45,14 +46,15 @@ openjfxVersion = 11.0.2 icegridguiProguard = true // -// Set the version of the Ice Builder to use for building. It must be set to debian -// when using the gradle-ice-builder-plugin package on Debian. +// Set the version of the Ice Builder to use for building. It must be set +// to debian when using the gradle-ice-builder-plugin package on Debian. // iceBuilderVersion = 1.4.7 // -// Set the builder artifact class path. It must be set to com.zeroc.gradle.ice-builder -// when using the gradle-ice-builder-plugin package. +// Set the builder artifact class path. It must be set to +// com.zeroc.gradle.ice-builder when using the gradle-ice-builder-plugin +// package. // iceBuilderClassPath = gradle.plugin.com.zeroc.gradle.ice-builder @@ -72,15 +74,16 @@ devRepo = // // -// The platform uses by the C++ builds, supported values are `x64` and `Win32`, -// that is required to locate the slice2java compiler in the platform depend -// directory. +// The platform uses by the C++ builds, supported values are `x64` and +// `Win32`, that is required to locate the slice2java compiler in the +// platform depend directory. // cppPlatform = // -// The configuration uses by the C++ builds, supported values are `Debug` and `Release`, -// that is required to locate the slice2java compiler in the configuration depend +// The configuration uses by the C++ builds, supported values are `Debug` +// and `Release`, that is required to locate the slice2java compiler in +// the configuration depend // directory. // cppConfiguration = diff --git a/js/README.md b/js/README.md index 9f4ee096352..38a8d3c981f 100644 --- a/js/README.md +++ b/js/README.md @@ -42,8 +42,8 @@ npm run build ``` On Windows, you need to set the platform and configuration in order to locate -`slice2js`. For example, if you have built C++ with the x64 Release configuration, -you can use the following command to build JavaScript: +`slice2js`. For example, if you have built C++ with the x64 Release +configuration, you can use the following command to build JavaScript: ``` npm run build -- --cppPlatform x64 --cppConfiguration Release ``` @@ -143,11 +143,11 @@ depending on the browser you're using: - Internet Explorer and Microsoft Edge Run the management console (mmc.exe) and add the Certificates snap-in for - the computer account. Then select Console Root > Certificates (Local Computer) - \> Trusted Root Certificate Authorities. In the Action menu, choose All Tasks - and Import. Navigate to the `cacert.der` file and import it into the Trusted - Root Certificate Authorities. Reload the test page to continue. You should - uninstall this certificate after running the tests. + the computer account. Then select Console Root > Certificates (Local + Computer) > Trusted Root Certificate Authorities. In the Action menu, choose + All Tasks and Import. Navigate to the `cacert.der` file and import it into + the Trusted Root Certificate Authorities. Reload the test page to continue. + You should uninstall this certificate after running the tests. #### Windows 8 @@ -202,7 +202,7 @@ npm install ice-3.7.3.tgz To use Ice for JavaScript with a browser, copy the appropriate JavaScript library files located in the `lib` directory to your web server. -[1]: https://zeroc.com/distributions/ice +[1]: https://zeroc.com/downloads/ice [2]: https://babeljs.io [3]: https://www.npmjs.com/package/core-js [4]: https://www.npmjs.com/package/regenerator-runtime diff --git a/matlab/README.md b/matlab/README.md index 7af707eac48..b330d8c1238 100644 --- a/matlab/README.md +++ b/matlab/README.md @@ -2,8 +2,8 @@ This document describes how to build and install Ice for MATLAB from source. -ZeroC provides Ice for MATLAB [toolboxes][1] for all recent versions of MATLAB on Windows, -so building Ice for MATLAB from source is usually unnecessary. +ZeroC provides Ice for MATLAB [toolboxes][1] for all recent versions of MATLAB +on Windows, so building Ice for MATLAB from source is usually unnecessary. * [Prerequisites](#prerequisites) * [Build Instructions](#build-instructions) @@ -48,9 +48,10 @@ Upon completion, a build in release mode generates the following components: - MATLAB code for core Slice files, located in `matlab\lib\generated` - MATLAB code for test Slice files, located in `matlab\test\**\generated` -The MATLAB extension depends on Ice for C++ components from the cpp subdirectory, -and those are built if required. It is also possible to build the MATLAB extension -using Ice C++ NuGet packages by setting the ICE_BIN_DIST msbuild property to cpp: +The MATLAB extension depends on Ice for C++ components from the `cpp` +subdirectory, and those are built if required. It is also possible to build the +MATLAB extension using Ice C++ NuGet packages by setting the `ICE_BIN_DIST` +msbuild property to `cpp`: ``` msbuild msbuild\ice.proj /p:ICE_BIN_DIST=cpp diff --git a/php/README.md b/php/README.md index 18d106eb679..55323f8c0d7 100644 --- a/php/README.md +++ b/php/README.md @@ -94,10 +94,10 @@ extension with namespaces disabled by setting the MSBuild property msbuild msbuild\ice.proj /p:PhpUseNamespaces=no ``` -The PHP extension is build by default using PHP 7.1, the extension can be build with -PHP 7.1, 7.2 or 7.3 by setting MSBuildProperty `BuildWithPhpVersion` to the desired -version for example you can use the following command to build the extension with PHP -7.2: +The PHP extension is build by default using PHP 7.1, the extension can be build +with PHP 7.1, 7.2 or 7.3 by setting MSBuildProperty `BuildWithPhpVersion` to the +desired version for example you can use the following command to build the +extension with PHP 7.2: ``` msbuild msbuild\ice.proj /p:BuildWithPhpVersion=7.2 @@ -253,16 +253,15 @@ The Ice extension makes no assumptions about the location of these files, so you can install them anywhere you like. For example, you can simply include them in the same directory as your application scripts. Alternatively, if you prefer to install them in a common directory, you may need to modify PHP's `include_path` -directive so that the PHP interpreter is able to locate these files. For example, -you could append to `php.ini`: +directive so that the PHP interpreter is able to locate these files. For +example, you could append to `php.ini`: ``` include_path=${include_path}";C\ice\php\lib" ``` Another option is to modify the include path from within your script prior to -including any Ice run-time file. Here is an example that assumes Ice is installed -in -`/opt`: +including any Ice run-time file. Here is an example that assumes Ice is +installed in `/opt`: ``` // PHP ini_set('include_path', diff --git a/python/README.md b/python/README.md index a07dca4cf6c..3e59632e8a7 100644 --- a/python/README.md +++ b/python/README.md @@ -143,4 +143,4 @@ python allTests.py If everything worked out, you should see lots of `ok` messages. In case of a failure, the tests abort with `failed`. -[1]: https://zeroc.com/distributions/ice +[1]: https://zeroc.com/downloads/ice diff --git a/ruby/README.md b/ruby/README.md index b362c5475a1..fb8b982f8f0 100644 --- a/ruby/README.md +++ b/ruby/README.md @@ -38,12 +38,6 @@ ruby-libs (RHEL) The instructions for compiling the Ice extension assume that you have already installed Ruby. -If you installed Ruby in a non-standard location, set the `RUBY_HOME` -environment variable to the installation directory. For example: -``` -export RUBY_HOME=/opt/ruby -``` - The build of Ice for Ruby requires that you first build Ice for C++ in the `cpp` subdirectory. @@ -68,7 +62,8 @@ This process uses the `prefix` variable in `../config/Make.rules` as the installation's root directory. The subdirectory `<prefix>/ruby` is created as a copy of the local `ruby` directory and contains the Ice for Ruby extension library as well as Ruby source code. Using this installation method requires -that you modify your environment as described in *Using Ice for Ruby* below. +that you modify your environment as described in *Configuring your Environment +for Ruby* below. Another option is to copy the contents of the local `ruby` directory to your Ruby installation's `site_ruby` directory. For example, if you installed Ruby diff --git a/swift/README.md b/swift/README.md index 7bc572224c8..23e20ad8a62 100644 --- a/swift/README.md +++ b/swift/README.md @@ -14,41 +14,52 @@ resulting build. ## Swift Build Requirements ### Operating Systems + Ice for Swift builds and runs on macOS and is supported on the platforms listed on the [supported platforms][2] page. ### Slice to Swift Compiler -You need the Slice to Swift compiler to build Ice for Swift and also to use -Ice for Swift. The Slice to Swift compiler (`slice2swift`) is a command-line tool + +You need the Slice to Swift compiler to build Ice for Swift and also to use Ice +for Swift. The Slice to Swift compiler (`slice2swift`) is a command-line tool written in C++. You can build the Slice to Swift compiler from source, or -alternatively you can install an Ice [binary distribution][1] that includes -this compiler. +alternatively you can install an Ice [binary distribution][1] that includes this +compiler. ### Swift Version + Ice for Swift requires Swift 5 or later. ### Carthage -Carthage must be installed to build Ice for Swift. You can install Carthage using Homebrew: + +Carthage must be installed to build Ice for Swift. You can install Carthage +using Homebrew: ``` brew install carthage ``` ## Building Ice for Swift + First download and build the PromiseKit framework by running: ``` carthage update ``` from the root directory of your ice repository. -Then open `ice.xcodeproj` with Xcode and build the `Ice macOS` or `Ice iOS` targets. +Then open `ice.xcodeproj` with Xcode and build the `Ice macOS` or `Ice iOS` +targets. The test programs for macOS and iOS can be built using `TestDriver macOS` and `TestDriver iOS` respectively. ## Running the Swift Test Suite + Python is required to run the test suite. ### macOS + +After a successful build, you can run the tests as follows: + ``` python allTests.py --config Debug ``` @@ -57,7 +68,9 @@ If everything worked out, you should see lots of `ok` messages. In case of a failure, the tests abort with `failed`. ### iOS -Start the `TestDriver iOS` app on your iOS device or simulator, from Xcode. + +Start the `TestDriver iOS` application on your iOS device or simulator, from +Xcode. Then on your mac, run: ``` |