Repetition of open-source project

contributions/open-source/perfah-applelid/README.md

@@ -1,13 +1,17 @@
 # Patching wlroots-sys
 
+## Members
+1. Per Fahlander ([email protected])
+2. Gunnar Applelid ([email protected])
+
 ## Links to what we did
 [Repository](https://github.com/perfah/wlroots-rs)
 
 [Reflection & Contribution document](https://github.com/perfah/wlroots-rs/wiki/devops-course:-Reflection-&-Contributions)
 
-## Members
-1. Per Fahlander ([email protected])
-2. Gunnar Applelid ([email protected])
+[Pull request](https://github.com/swaywm/wlroots-rs/pull/300)
+
+[Passing build](https://builds.sr.ht/~timidger/job/214237)
 
 ## Proposal
 Patch the crate [wlroots-sys](https://github.com/swaywm/wlroots-rs/tree/master/wlroots-sys) belonging to the deprecated [wlroots-rs](https://github.com/swaywm/wlroots-rs) (rust bindings for [wlroots](https://github.com/swaywm/wlroots)) library to suit it for use in other projects directly.
@@ -35,11 +39,11 @@ Some suggestions for tangible changes to the crate:
 - Add a README / documentation page
 
 
-## Motivation
+### Motivation
 
 The project was deprecated due to the author giving up on it. There is however interest in the the project (see stars on GitHub) since the project (including it's subcrates) is a useful resource for developing Wayland-compositors in the Rust-language. Patching wlroots-sys would make it possible to interface with the wl-roots c-library directly without dependencies to deprecated bindings.
 
-## Ties to DevOps
+### Ties to DevOps
 
 The project would involve the following:
 
@@ -50,7 +54,7 @@ The project would involve the following:
 - Making it as **self-contained** as possible (containerization)
 
 
-## Context
+### Context
 
 - Rust: a programming language
 
@@ -63,3 +67,55 @@ The project would involve the following:
 - wlroots-rs: A deprecated library with Rust-bindings for Wlroots. 
 
 - wlroots-sys: A deprecated library within wlroots-rs that offers auto-generation of "raw" bindings from C to Rust.
+
+
+## Project: wlroots-sys
+
+A fork intended for standalone use of the wlroots-sys subcrate (that generates "raw" Rust bindings for [wlroots](https://github.com/swaywm/wlroots) via bindgen). This means that the development is contained only within the [wlroots-sys](https://github.com/perfah/wlroots-rs/tree/master/wlroots-sys) directory. Note that this is not an attempt to revive wlroots-rs - hence the largely untouched repository root. The motivation for this fork is the benefit of being able to write Wayland-compositors based on wlroots in Rust without relying on outdated protocols, dependencies etc.... See below if you are interested in writing one yourself.
+
+### Changes
+
+The following changes have been merged into master:
+
+- Exposed (updated to reflect) all wlr/protocols currently available [here](https://github.com/swaywm/wlroots/tree/master/protocol)
+- Exposed (updated to reflect) all wlr/types currently available [here](https://github.com/swaywm/wlroots/tree/master/types)
+- Updated all dependencies of wlroots-sys to the current versions (including the library suite “wayland-rs” to >=0.25.*)
+- Fixed a bug where wlroots-sys would not compile. The multi-crate issue is described [here](https://users.rust-lang.org/t/unable-to-compile-syntex-syntax-using-rust-1-41/37710).
+- Fixed a bug where the wlroots-sys crate would recompile every time you compile another crate that depends on wlroots-sys
+- Added informative dependency checks as well as more constructive error messages for pkg-config when building default, static and unstable, for a smoother build process.
+- Fixed errors with static build with new version of wlroots.
+- Compatibility changes for wlroots-rs (makes CI pass)
+
+### Usage
+
+1. `git clone https://github.com/perfah/wlroots-rs.git`
+2. `cd wlroots-rs`
+3. `git submodule update --init`
+4. `cp ./wlroots-sys <path_to_your_project>/wlroots-sys`
+5. Include a crate dependency to your project's `cargo.toml`-file:
+
+        [dependencies]
+        wlroots-sys = { path = "wlroots-sys", features = [...] }
+6. Replace "..." with the optional dependencies you would like.
+
+### Dependencies
+
+- Required dependencies:
+
+        meson
+        wayland
+        wayland-protocols
+        EGL
+        GLESv2
+        libdrm
+        GBM
+        libinput
+        xkbcommon
+        udev 
+
+- Optional dependencies (that can be added as features):   
+    - `systemd` - support for logind
+    - `elogind` - support for logind without systemd installed
+    - `libcap` - capabilities
+
+