Skip to content

Commit 3137e2a

Browse files
committed
fix(lint): update readme by cleaning template stuff
1 parent 28df736 commit 3137e2a

File tree

1 file changed

+5
-41
lines changed

1 file changed

+5
-41
lines changed

README.md

+5-41
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,8 @@
1-
# Rust Template
1+
# 📝 Contracts
22

3-
> Template for Rust projects @okp4.
4-
5-
[![version](https://img.shields.io/github/v/release/okp4/template-rust?style=for-the-badge)](https://github.com/okp4/template-rust/releases)
6-
[![build](https://img.shields.io/github/workflow/status/okp4/template-rust/Build?label=build&style=for-the-badge)](https://github.com/okp4/template-rust/actions/workflows/build.yml)
7-
[![lint](https://img.shields.io/github/workflow/status/okp4/template-rust/Lint?label=lint&style=for-the-badge)](https://github.com/okp4/template-rust/actions/workflows/lint.yml)
8-
[![test](https://img.shields.io/github/workflow/status/okp4/template-rust/Test?label=test&style=for-the-badge)](https://github.com/okp4/template-rust/actions/workflows/test.yml)
9-
[![codecov](https://img.shields.io/codecov/c/github/okp4/template-rust?style=for-the-badge&token=K5CYM8TQQY)](https://codecov.io/gh/okp4/template-rust)
3+
[![version](https://img.shields.io/github/v/release/okp4/contracts?style=for-the-badge)](https://github.com/okp4/contracts/releases)
4+
[![build](https://img.shields.io/github/workflow/status/okp4/contracts/Build?label=build&style=for-the-badge)](https://github.com/okp4/contracts/actions/workflows/build.yml)
5+
[![lint](https://img.shields.io/github/workflow/status/okp4/contracts/Lint?label=lint&style=for-the-badge)](https://github.com/okp4/contracts/actions/workflows/lint.yml)
6+
[![test](https://img.shields.io/github/workflow/status/okp4/contracts/Test?label=test&style=for-the-badge)](https://github.com/okp4/contracts/actions/workflows/test.yml)
107
[![conventional commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg?style=for-the-badge)](https://conventionalcommits.org)
118
[![License](https://img.shields.io/badge/License-BSD_3--Clause-blue.svg?style=for-the-badge)](https://opensource.org/licenses/BSD-3-Clause)
12-
13-
## Purpose & Philosophy
14-
15-
This repository holds the template for building Rust projects with a consistent set of standards accross all [OKP4](https://github.com/okp4) projects. We are convinced that the quality of the code depends on clear and consistent coding conventions, with an automated enforcement (CI).
16-
17-
This way, the template promotes:
18-
19-
- the use of [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/), [semantic versionning](https://semver.org/) and [semantic releasing](https://github.com/cycjimmy/semantic-release-action) which automates the whole package release workflow including: determining the next version number, generating the release notes, and publishing the artifacts (project tarball, docker images, etc.)
20-
- unit testing
21-
- linting via [rust-clippy](https://github.com/rust-lang/rust-clippy)
22-
- formatting via [rustfmt](https://github.com/rust-lang/rustfmt)
23-
- a uniform way of building via [cargo-make](https://github.com/sagiegurari/cargo-make)
24-
25-
## How to use
26-
27-
> 🚨 do not fork this repository as it is a [template repository](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template)
28-
29-
1. Click on [Use this template](https://github.com/okp4/template-rust/generate)
30-
2. Give a name to your project
31-
3. Wait until the first run of CI finishes
32-
4. Clone your new project and happy coding!
33-
34-
⚠ Do not forget to adapt your project to your needs by editing the `Cargo.toml` file.
35-
36-
## Prerequisites
37-
38-
Be sure you have [Rust](https://www.rust-lang.org/tools/install) properly installed with [cargo-make](https://github.com/sagiegurari/cargo-make).
39-
40-
## Build
41-
42-
```sh
43-
cargo make
44-
```

0 commit comments

Comments
 (0)