Skip to content

Commit 9e39755

Browse files
chore: update readme template
1 parent 69a9b69 commit 9e39755

1 file changed

Lines changed: 45 additions & 17 deletions

File tree

templates/readme_template.md

Lines changed: 45 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -62,33 +62,59 @@ This template uses [Remix icon set](https://remixicon.com/)
6262

6363
It is added to the app as a font generated by [icomoon app](https://icomoon.io/app/#/select).
6464

65-
## Adding new icons
65+
- [adding new icon docs](https://baca-docs.vercel.app/docs/icons)
6666

67-
1. Find `assets/icomoon/selection.json` file in your machine
68-
2. Import this file to this [page (icomoon app)](https://icomoon.io/app/#/select):
67+
<!-- TODO: Improve this step -->
6968

70-
- Make sure there are no other icons imported there
69+
## Sync up with template:
7170

72-
3. Download icon which need to be added to the app as svg file.
73-
4. Make sure new icon name is unique (already not used).
74-
5. Add svg file to icomoon app.
75-
6. Go to generate font tab - icomoon app.
71+
<details>
7672

77-
- Make sure that all icons that you have added have correct names
73+
<summary>With git history</summary>
7874

79-
7. Download font - icomoon app
80-
8. Replace old files with downloaded ones
75+
This tutorial is needed when you clone baca-react-native-template and you keep git repository
8176

82-
- ./selection.json => assets/icomoon/selection.json
83-
- ./fonts/icomoon.ttf => assets/icomoon/icomoon.ttf
77+
1. Add template remote
8478

85-
9. Generate new types for icons
79+
```bash
80+
git remote add template git@github.com:binarapps/baca-react-native-template.git
81+
```
8682

87-
- run script generating icon types `yarn g icon-types` and pick icon types
83+
2. Go to new branch (for safety reason)
8884

89-
<!-- TODO: Improve this step -->
85+
```bash
86+
git checkout -b "sync_with_template/1"
87+
```
9088

91-
## Sync up with template:
89+
3. Fetch template remote
90+
91+
```bash
92+
git fetch template
93+
```
94+
95+
4. Merge with template
96+
97+
```bash
98+
git merge template/main --no-commit
99+
```
100+
101+
5. Review changes
102+
103+
- There can be some issues with files that you were also working, make sure merge doesnt remove your logic
104+
105+
6. Adjust and commit changes
106+
107+
```bash
108+
git commit -m "chore: sync up with template code"
109+
```
110+
111+
</details>
112+
113+
<details>
114+
115+
<summary>No git history</summary>
116+
117+
This tutorial is needed when you don't have git history from baca-react-native-template
92118

93119
1. Add template remote
94120

@@ -124,6 +150,8 @@ git merge -X theirs template/main --allow-unrelated-histories --no-commit
124150
git commit -m "chore: sync up with template code"
125151
```
126152

153+
</details>
154+
127155
<!--
128156
TODO: ISSUE-33 (https://github.com/binarapps/baca-react-native-template/issues/33)
129157
Replace this section witha a new UI lib instructions when this issue will be done.

0 commit comments

Comments
 (0)