Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document where the .bib file is saved #22

Merged
merged 1 commit into from
Oct 21, 2021
Merged

Document where the .bib file is saved #22

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,9 @@ get_tool_citation()
```
which will print a sentence with the citations for all the packages used in the current
environment and will automatically copy it to the clipboard.
It will also create a `julia_citations.bib` file with all the citations collected form
the CITATION.bib files corresponding to the dependecies of the current active environment.
It will also create a `julia_citations.bib` file in the current working directory
with all the citations collected form the CITATION.bib files
corresponding to the dependecies of the current active environment.

If you only need the .bib file with all the citations, use
```julia
Expand Down
3 changes: 3 additions & 0 deletions docs/src/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,3 +40,6 @@ If you also need to get the automatically generated sentence referencig Julia, y
```@docs
get_tool_citation
```

!!! tip
By default, the `julia_citations.bib` file is saved in the current directory. To change the name or the save location of the generated `.bib`, you can just pass a path in the `filename` keyword argument, such as `get_tool_citation(filename="path/to/bib_file.bib")`.