Index: README.md ================================================================== --- README.md +++ README.md @@ -9,14 +9,15 @@

Table of Contents

* [What is ObjFW?](#what) + * [Installation](#installation) * [License](#license) * [Releases](#releases) * [Cloning the repository](#cloning) - * [Installation](#installation) + * [Building from source](#building-from-source) * [macOS and iOS](#macos-and-ios) * [Building as a framework](#building-framework) * [Using the macOS or iOS framework in Xcode](#framework-in-xcode) * [Broken Xcode versions](#broken-xcode-versions) * [Windows](#windows) @@ -72,10 +73,29 @@ ObjFW also comes with its own lightweight and extremely fast Objective-C runtime, which in real world use cases was found to be significantly faster than both GNU's and Apple's runtime. + +

Installation

+ + ObjFW packages are available for various operating systems and can be + installed as following: + + Operating System | Command + ------------------|--------------------------------------------- + Alpine Linux Edge | `doas apk add objfw` + CRUX Linux | `prt-get depinst objfw` + Fedora | `sudo dnf install objfw` + macOS (Homebrew) | `brew install objfw` + macOS (pkgsrc) | `cd $PKGSRCDIR/devel/objfw && make install` + NetBSD | `cd /usr/pkgsrc/devel/objfw && make install` + OpenBSD | `doas pkg_add objfw` + + If your operating system is not listed, you can + build ObjFW from source. +

License

ObjFW is released under three licenses: @@ -91,11 +111,11 @@ none of them work for you, contact me and we can find a solution.

Releases

- Releases of ObjFW, as well as changelogs and the accompanying documentation + Releases of ObjFW, as well as change logs and the accompanying documentation, can be found [here](https://objfw.nil.im/wiki?name=Releases).

Cloning the repository

@@ -139,13 +159,13 @@ $ git clone https://github.com/ObjFW/ObjFW Git commits are not signed, so if you want to check the signature of an individual commit, branch head or tag, please use Fossil. -

Installation

+

Building from source

- To install ObjFW, just run the following commands: + To build ObjFW from source and install it, just run the following commands: $ ./configure $ make $ make check $ sudo make install @@ -162,11 +182,11 @@ When building for macOS or iOS, everything is built as a `.framework` by default if `--disable-shared` has not been specified to `./configure`. The frameworks will end up in `$PREFIX/Library/Frameworks`. To build for macOS, just follow the - regular instructions above. + regular instructions above. To build for iOS, follow the regular instructions, but instead of `./configure` do something like this: $ clang="xcrun --sdk iphoneos clang"