Skip to content

Commit 5c9b9db

Browse files
committed
Add Troubleshooting scection to README md
1 parent 0774df4 commit 5c9b9db

File tree

1 file changed

+40
-0
lines changed

1 file changed

+40
-0
lines changed

README.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -170,6 +170,46 @@ tests deploys
170170
python application
171171
```
172172

173+
## Troubleshooting
174+
175+
If it's not working:
176+
177+
delete space to the left of key value pairs in BibTex.bib file
178+
179+
e.g.
180+
181+
```BibTex
182+
@article{vaswani2023attentionneed,
183+
title={Attention Is All You Need},
184+
author={Ashish Vaswani and Noam Shazeer and Niki Parmar and Jakob Uszkoreit and Llion Jones and Aidan N. Gomez and Lukasz Kaiser and Illia Polosukhin},
185+
year={2023},
186+
eprint={1706.03762},
187+
archivePrefix={arXiv},
188+
primaryClass={cs.CL},
189+
url={https://arxiv.org/abs/1706.03762},
190+
}
191+
```
192+
193+
to this:
194+
195+
```BibTex
196+
@article{vaswani2023attentionneed,
197+
title={Attention Is All You Need},
198+
author={Ashish Vaswani and Noam Shazeer and Niki Parmar and Jakob Uszkoreit and Llion Jones and Aidan N. Gomez and Lukasz Kaiser and Illia Polosukhin},
199+
year={2023},
200+
eprint={1706.03762},
201+
archivePrefix={arXiv},
202+
primaryClass={cs.CL},
203+
url={https://arxiv.org/abs/1706.03762},
204+
}
205+
```
206+
207+
also try ensuring BibTex.bib starts with
208+
209+
```BibTex
210+
@article
211+
```
212+
173213
## References
174214

175215
see [documentation](https://github.com/CoderSales/AI-Research-Project-Referencing-Program/tree/main/documentation)

0 commit comments

Comments
 (0)