Skip to content

Commit d1f05dd

Browse files
authored
docs: update README
1 parent 0286af3 commit d1f05dd

1 file changed

Lines changed: 18 additions & 1 deletion

File tree

README.md

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,11 @@
44

55
[![Release](https://img.shields.io/github/release/ietf-tools/datatracker.svg?style=flat&maxAge=300)](https://github.com/ietf-tools/datatracker/releases)
66
[![License](https://img.shields.io/github/license/ietf-tools/datatracker)](https://github.com/ietf-tools/datatracker/blob/main/LICENSE)
7-
[![Nightly Dev DB Image](https://github.com/ietf-tools/datatracker/actions/workflows/dev-db-nightly.yml/badge.svg)](https://github.com/ietf-tools/datatracker/pkgs/container/datatracker-db)
7+
[![Nightly Dev DB Image](https://github.com/ietf-tools/datatracker/actions/workflows/dev-db-nightly.yml/badge.svg)](https://github.com/ietf-tools/datatracker/pkgs/container/datatracker-db)
8+
[![Python Version](https://img.shields.io/badge/python-3.6-blue?logo=python&logoColor=white)](#prerequisites)
9+
[![Django Version](https://img.shields.io/badge/django-2.x-51be95?logo=django&logoColor=white)](#prerequisites)
10+
[![Node Version](https://img.shields.io/badge/node.js-16.x-green?logo=node.js&logoColor=white)](#prerequisites)
11+
[![MariaDB Version](https://img.shields.io/badge/mariadb-10-blue?logo=mariadb&logoColor=white)](#prerequisites)
812

913
##### The day-to-day front-end to the IETF database for people who work on IETF standards.
1014

@@ -41,6 +45,19 @@ You can submit bug reports, enhancement and new feature requests in the [discuss
4145

4246
> See the [Docker Dev Environment](#docker-dev-environment) section below for a preconfigured docker environment.
4347
48+
#### Git Cloning Tips
49+
50+
Because of the extensive history of this project, cloning the datatracker project locally can take a long time / disk space. You can speed up the cloning process by limiting the history depth:
51+
52+
- To fetch only up to the 10 latest commits:
53+
```sh
54+
git clone --depth=10
55+
```
56+
- To fetch only up to a specific date:
57+
```sh
58+
git clone --shallow-since=DATE
59+
```
60+
4461
#### Code Tree Overview
4562

4663
The `ietf/templates/` directory contains Django templates used to generate web pages for the datatracker, mailing list, wgcharter and other things.

0 commit comments

Comments
 (0)