Skip to content

Commit 1c54cec

Browse files
Added UI workflow gif & url fixes in README.md
1 parent c199acd commit 1c54cec

File tree

2 files changed

+14
-20
lines changed

2 files changed

+14
-20
lines changed

README.md

Lines changed: 14 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,6 @@
11
<h1 align="center">Attendance System using Face Recognition</h1>
22
<p>
33
<img alt="Version" src="https://img.shields.io/badge/version-1.0.0-blue.svg?cacheSeconds=2592000" />
4-
<a href="https://github.com/codeglitchz/attendance-system#readme" target="_blank">
5-
<img alt="Documentation" src="https://img.shields.io/badge/documentation-yes-brightgreen.svg" />
6-
</a>
7-
<a href="https://github.com/codeglitchz/attendance-system/graphs/commit-activity" target="_blank">
8-
<img alt="Maintenance" src="https://img.shields.io/badge/Maintained%3F-yes-green.svg" />
9-
</a>
104
<a href="https://github.com/codeglitchz/attendance-system/blob/master/LICENSE" target="_blank">
115
<img alt="License: MIT" src="https://img.shields.io/github/license/codeglitchz/attendance-system" />
126
</a>
@@ -15,31 +9,35 @@
159
> A simple, modern and scalable facial recognition based attendance system
1610
> built with Python back-end & Angular front-end
1711
18-
### 🏠 [Homepage](https://github.com/codeglitchz/attendance-system#readme)
12+
#### [UI](https://github.com/codeglitchz/attendance-system/blob/master/sample/ui.gif)
1913

2014
## Table of contents
2115
* [Prerequisites](#prerequisites)
2216
* [Installation](#installation)
23-
1. [Clone repository](#clone-repository)
24-
2. [Setup backend](#setup-backend)
25-
3. [Setup frontend](#setup-frontend)
26-
* [Usage](#usage)
27-
1. [Using CLI](#using-cli)
28-
2. [Using Web Interface](#using-web-interface)
17+
1. [Clone repository](#1-clone-repository)
18+
2. [Setup backend](#2-setup-backend)
19+
3. [Setup frontend](#3-setup-frontend)
20+
* [Usage](#usage)\
21+
a. [Using CLI](#a-using-cli)\
22+
b. [Using Web Interface](#b-using-web-interface)
2923

3024
## Prerequisites
3125

3226
* Python v3.7+
3327
* Miniconda3 (optional) (recommended)
28+
* CMake
29+
* Visual Studio Build Tools
30+
* Nvidia CUDA (optional - for nvidia gpus)
3431
* Node.js LTS v12.8.0+ (npm v6.14.4+)
3532
* Angular CLI v9.1.8+
3633
* Windows or Linux (macOS not officially supported, but might work)
3734

3835
## Installation
3936

4037
#### 1. Clone repository
38+
For stable release, clone `master` branch
4139
```sh
42-
$ git clone https://github.com/codeglitchz/attendance-system
40+
$ git clone -b master https://github.com/codeglitchz/attendance-system.git
4341
$ cd attendance-system
4442
```
4543
#### 2. Setup backend
@@ -96,13 +94,9 @@ $ ng serve -o
9694

9795
## Authors
9896

99-
👤 **CodeGlitchz**
100-
101-
* Github: [@codeglitchz](https://github.com/codeglitchz)
102-
103-
👤 **CodeWhizz**
97+
👤 [**@codeglitchz**](https://github.com/codeglitchz)
10498

105-
* Github: [@codewhizz](https://github.com/codewhizz)
99+
👤 [**@codewhizz**](https://github.com/codewhizz)
106100

107101
## 🤝 Contributing
108102

sample/ui.gif

6.37 MB
Loading

0 commit comments

Comments
 (0)