-
Notifications
You must be signed in to change notification settings - Fork 11
Expand file tree
/
Copy pathREADME.tpl
More file actions
125 lines (92 loc) · 3.01 KB
/
README.tpl
File metadata and controls
125 lines (92 loc) · 3.01 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
[](./LICENSE)
[](https://crates.io/crates/pricelevel)
[](https://crates.io/crates/pricelevel)
[](https://github.com/joaquinbejar/PriceLevel/stargazers)
[](https://github.com/joaquinbejar/PriceLevel/issues)
[](https://github.com/joaquinbejar/PriceLevel/pulls)
[](https://github.com/joaquinbejar/PriceLevel/actions)
[](https://codecov.io/gh/joaquinbejar/PriceLevel)
[](https://libraries.io/github/joaquinbejar/PriceLevel)
[](https://docs.rs/pricelevel)
{{readme}}
## Setup Instructions
1. Clone the repository:
```shell
git clone https://github.com/joaquinbejar/PriceLevel.git
cd PriceLevel
```
2. Build the project:
```shell
make build
```
3. Run tests:
```shell
make test
```
4. Format the code:
```shell
make fmt
```
5. Run linting:
```shell
make lint
```
6. Clean the project:
```shell
make clean
```
7. Run the project:
```shell
make run
```
8. Fix issues:
```shell
make fix
```
9. Run pre-push checks:
```shell
make pre-push
```
10. Generate documentation:
```shell
make doc
```
11. Publish the package:
```shell
make publish
```
12. Generate coverage report:
```shell
make coverage
```
## Library Usage
To use the library in your project, add the following to your `Cargo.toml`:
```toml
[dependencies]
pricelevel = { git = "https://github.com/joaquinbejar/PriceLevel.git" }
```
## Usage Examples
Here are some examples of how to use the library:
## Testing
To run unit tests:
```shell
make test
```
To run tests with coverage:
```shell
make coverage
```
## Contribution and Contact
We welcome contributions to this project! If you would like to contribute, please follow these steps:
1. Fork the repository.
2. Create a new branch for your feature or bug fix.
3. Make your changes and ensure that the project still builds and all tests pass.
4. Commit your changes and push your branch to your forked repository.
5. Submit a pull request to the main repository.
If you have any questions, issues, or would like to provide feedback, please feel free to contact the project maintainer:
**Joaquín Béjar García**
- Email: jb@taunais.com
- **Telegram**: [@joaquin_bejar](https://t.me/joaquin_bejar)
- GitHub: [joaquinbejar](https://github.com/joaquinbejar)
We appreciate your interest and look forward to your contributions!
License: MIT