Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #616

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
92 changes: 82 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,85 @@
**www.openbiometrics.org**
# 🔬 **Open Biometrics Resource (OpenBR)**

1) Identify the latest stable [release tag](https://github.com/biometrics/openbr/releases) such as "v1.1.0"
Welcome to **[OpenBR](https://www.openbiometrics.org)**, an open-source biometrics library designed for research and development in pattern recognition and machine learning.

2) Download all OpenBR source code and switch to that release tag:
---

$ git clone https://github.com/biometrics/openbr.git
$ cd openbr
$ git checkout <tag> (eg: git checkout v1.1.0)
$ git submodule init
$ git submodule update

3) Build OpenBR by following the **[Build Instructions](http://openbiometrics.org/docs/install/)** for your OS.
## 🚀 **Getting Started**

### 1️⃣ Identify the Latest Stable Release

Check the latest stable [release tag](https://github.com/biometrics/openbr/releases). For example, the most recent tag could be `"v1.1.0"`.

---

### 2️⃣ Download the OpenBR Source Code

Clone the OpenBR repository and switch to the identified release tag:

```bash
# Clone the repository
$ git clone https://github.com/biometrics/openbr.git

# Navigate to the project directory
$ cd openbr

# Checkout the desired release tag (e.g., v1.1.0)
$ git checkout <tag> # Replace <tag> with the release tag, e.g., git checkout v1.1.0

# Initialize and update submodules
$ git submodule init
$ git submodule update
```

---

### 3️⃣ Build OpenBR

Follow the **[Build Instructions](http://openbiometrics.org/docs/install/)** specific to your operating system to compile OpenBR.

---

## 🛠️ **Features**

- **Open Source:** Fully open and free for academic and commercial use.
- **Cross-Platform:** Compatible with major operating systems like Linux, macOS, and Windows.
- **Extensible:** Built to support various biometric applications such as face, fingerprint, and iris recognition.

---

## 📘 **Documentation**

Find comprehensive documentation at **[OpenBR Docs](http://openbiometrics.org/docs/)**. This includes installation guides, tutorials, and API references to help you get started and leverage OpenBR effectively.

---

## 🤝 **Contributing**

We welcome contributions! Here's how you can get involved:

1. Fork the repository.
2. Create a new branch:
```bash
git checkout -b feature-branch
```
3. Commit and push your changes:
```bash
git push origin feature-branch
```
4. Open a Pull Request for review.

---

## 🛡️ **Licensing**

OpenBR is licensed under the **Apache License 2.0**. See the [LICENSE](https://github.com/biometrics/openbr/blob/master/LICENSE) file for details.

---

## 📞 **Contact**

For questions or support, visit the **[OpenBR Community](http://openbiometrics.org/community/)**.

---

Let me know if you’d like further refinements! 😊