Skip to content

Commit 3215d24

Browse files
vmarcospMarcos Oliveira
authored and
Marcos Oliveira
committed
Adding Contributing guide and setup section to README.md
1 parent e58030a commit 3215d24

File tree

2 files changed

+32
-0
lines changed

2 files changed

+32
-0
lines changed

CONTRIBUTING.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
Contributing
2+
3+
Fork it! Create your feature branch: git checkout -b my-new-feature Commit your changes: git commit -m 'Add some feature' Push to the branch: git push origin my-new-feature Remember that we have a pre-push hook with steps that analyzes and prevents mistakes.
4+
5+
After your pull request is merged, you can safely delete your branch.

README.md

+27
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,9 @@
55
<p align="center">
66
<a target="_blank" href="https://timerlab.lukin.co">Site</a> •
77
<a href="#preview">Preview</a> •
8+
<a href="#preview">Setup</a> •
89
<a href="#license">License</a> •
10+
<a href="https://github.com/lukinco/timerlab/blob/master/CONTRIBUTING.md">Contributing</a> •
911
<a target="_blank" href="https://lukin.co">Lukin Co.</a>
1012
</p>
1113
<br/>
@@ -14,6 +16,31 @@
1416
## Preview
1517
![](./assets/preview.gif)
1618

19+
## Setup
20+
21+
This project uses `Create React App` and [ReScript/ReasonML](https://rescript-lang.org).
22+
23+
### Install dependencies
24+
```sh
25+
yarn
26+
```
27+
28+
### Development mode
29+
- ReScript compiler:
30+
```sh
31+
yarn bsb
32+
```
33+
34+
- CRA:
35+
```sh
36+
yarn start
37+
```
38+
39+
### Build
40+
```sh
41+
yarn build
42+
```
43+
1744
## License
1845

1946
MIT

0 commit comments

Comments
 (0)