search

charmbracelet / freeze

Generate images of code and terminal output 📸
MIT License
3.24k stars 55 forks source link

add macOS config file location information #60

Closed vigo closed 2 months ago

bashbunni commented 6 months ago

Hey @vigo thank you for the suggested changes :) I'm not sure that the README is the best place to document this. The program will show where files are saved on write, so I don't think this needs to be added to the documentation. If you feel otherwise, please let me know. Maybe there's a part of the picture I'm missing here.

This is what the output looks like after running in interactive mode image

maaslalani commented 6 months ago

Hey @vigo, the documentation is slightly incorrect since the file gets written to XDG_CONFIG_HOME when it is set. So even on macOS, it will get written to ~/.config if that is set as the XDG_CONFIG_HOME. However, if it is not set then yes, on macOS the file will be written to ~/Library/Application\ Support/freeze/user.json.

That being said, I agree with @bashbunni and don't think we necessarily need to tell the user about where the file is stored, but rather should mention XDG_CONFIG_HOME if it is confusing.

bashbunni commented 2 months ago

Hey @vigo did you have any further thoughts on this?