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.

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

Separate changelog and documentation in Readme. #254

Open
SeppPenner opened this issue Apr 7, 2019 · 1 comment
Open

Separate changelog and documentation in Readme. #254

SeppPenner opened this issue Apr 7, 2019 · 1 comment

Comments

@SeppPenner
Copy link

I would recommend to separate the changelog from the user documentation in the readme. Why? Because nobody wants to scroll down to the documentation while reading all the changes made from version 0.x to version 3.x. I would recommend to make a new file called changelog.md in the main folder or something and link it from the README.md file.

@aluxnimm
Copy link
Owner

aluxnimm commented Apr 7, 2019

Yes good point. Just need to change the update logic then as well since changes are grepped from readme atm.

You can read documentation also at

https://caldavsynchronizer.org/help/documentation/

@SeppPenner SeppPenner changed the title Seperate changelog and documentation in Readme. Separate changelog and documentation in Readme. Apr 8, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants