Index: README.md ================================================================== --- README.md +++ README.md @@ -11,10 +11,11 @@

Table of Contents

* [What is ObjFW?](#what) * [License](#license) * [Releases](#releases) + * [Cloning the repository](#cloning) * [Installation](#installation) * [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) @@ -91,10 +92,42 @@

Releases

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

Cloning the repository

+ + ObjFW is developed in a [Fossil](https://fossil-scm.org) repository, with + automatic incremental exports to Git. This means you can either clone the + Fossil repository or the Git repository - it does not make a huge difference. + The main advantage of cloning the Fossil repository over cloning the Git + repository is that you also get all the tickets, wiki pages, etc. + +

Fossil

+ + Clone the Fossil repository like this: + + $ fossil clone https://objfw.nil.im objfw.fossil + $ mkdir objfw && cd objfw + $ fossil open ../objfw.fossil + + You can then use Fossil's web interface to browse the timeline, tickets, + wiki pages, etc.: + + $ fossil ui + + It's also possible to open the same local repository multiple times, so that + you have multiple working directories all backed by the same local + repository. + +

Git

+ + To clone the Git repository, use the following: + + $ git clone https://github.com/ObjFW/ObjFW +

Installation

To install ObjFW, just run the following commands: