Overview
Comment: | README.md: Document how to install packages |
---|---|
Downloads: | Tarball | ZIP archive | SQL archive |
Timelines: | family | ancestors | descendants | both | trunk |
Files: | files | file ages | folders |
SHA3-256: |
ea8787d630a53a98d2b407bbc8b52e2e |
User & Date: | js on 2023-09-16 22:23:43 |
Other Links: | manifest | tags |
Context
2023-09-18
| ||
19:20 | README.md: Add instructions for FreeBSD check-in: bf29ed02a7 user: js tags: trunk | |
2023-09-16
| ||
22:23 | README.md: Document how to install packages check-in: ea8787d630 user: js tags: trunk | |
2023-09-14
| ||
21:04 | Similar User-Agent/Server in OFHTTP{Client,Server} check-in: 02f4bdcb94 user: js tags: trunk | |
Changes
Modified README.md from [af3f3c85c5] to [4bcfb11fbe].
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | There are three ways you are probably reading this right now: * On [ObjFW](https://objfw.nil.im/)'s homepage, via Fossil's web interface * On [GitHub](https://github.com/ObjFW/ObjFW) * Via an editor or pager, by opening `README.md` from a clone or tarball ObjFW is developed using Fossil, so if you are reading this on GitHub or any other place, you are most likely using a mirror. <h1 id="table-of-contents">Table of Contents</h1> * [What is ObjFW?](#what) * [License](#license) * [Releases](#releases) * [Cloning the repository](#cloning) | > | | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 | There are three ways you are probably reading this right now: * On [ObjFW](https://objfw.nil.im/)'s homepage, via Fossil's web interface * On [GitHub](https://github.com/ObjFW/ObjFW) * Via an editor or pager, by opening `README.md` from a clone or tarball ObjFW is developed using Fossil, so if you are reading this on GitHub or any other place, you are most likely using a mirror. <h1 id="table-of-contents">Table of Contents</h1> * [What is ObjFW?](#what) * [Installation](#installation) * [License](#license) * [Releases](#releases) * [Cloning the repository](#cloning) * [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) * [Getting MSYS2](#getting-msys2) * [Setting up MSYS2](#setting-up-msys2) |
︙ | ︙ | |||
70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 | leading to bugs. ObjFW fixes this by making exceptions a first class citizen. 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. <h1 id="license">License</h1> ObjFW is released under three licenses: * [QPL](LICENSE.QPL) * [GPLv2](LICENSE.GPLv2) * [GPLv3](LICENSE.GPLv3) The QPL allows you to use ObjFW in any open source project. Because the GPL does not allow using code under any other license, ObjFW is also available under the GPLv2 and GPLv3 to allow GPL-licensed projects to use ObjFW. You can pick under which of those three licenses you want to use ObjFW. If none of them work for you, contact me and we can find a solution. <h1 id="releases">Releases</h1> | > > > > > > > > > > > > > > > > > > > | | 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 | leading to bugs. ObjFW fixes this by making exceptions a first class citizen. 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. <h1 id="installation">Installation</h1> 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 <a href="#building-from-source">build ObjFW from source</a>. <h1 id="license">License</h1> ObjFW is released under three licenses: * [QPL](LICENSE.QPL) * [GPLv2](LICENSE.GPLv2) * [GPLv3](LICENSE.GPLv3) The QPL allows you to use ObjFW in any open source project. Because the GPL does not allow using code under any other license, ObjFW is also available under the GPLv2 and GPLv3 to allow GPL-licensed projects to use ObjFW. You can pick under which of those three licenses you want to use ObjFW. If none of them work for you, contact me and we can find a solution. <h1 id="releases">Releases</h1> Releases of ObjFW, as well as change logs and the accompanying documentation, can be found [here](https://objfw.nil.im/wiki?name=Releases). <h1 id="cloning">Cloning the repository</h1> ObjFW is developed in a [Fossil](https://fossil-scm.org) repository, with automatic incremental exports to Git. This means you can either clone the |
︙ | ︙ | |||
137 138 139 140 141 142 143 | To clone the Git repository, use the following: $ 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. | | | | | 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 | To clone the Git repository, use the following: $ 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. <h1 id="building-from-source">Building from source</h1> To build ObjFW from source and install it, just run the following commands: $ ./configure $ make $ make check $ sudo make install In case you checked out ObjFW from the Fossil or Git repository, you need to run the following command first: $ ./autogen.sh <h2 id="macos-and-ios">macOS and iOS</h2> <h3 id="building-framework">Building as a framework</h3> 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 <a href="#building-from-source">regular instructions</a> above. To build for iOS, follow the regular instructions, but instead of `./configure` do something like this: $ clang="xcrun --sdk iphoneos clang" $ export OBJC="$clang -arch arm64e -arch arm64" $ export OBJCPP="$clang -arch arm64e -E" |
︙ | ︙ |