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

Add ABOUT page #359

Merged
merged 6 commits into from
Apr 14, 2020
Merged

Add ABOUT page #359

merged 6 commits into from
Apr 14, 2020

Conversation

JMMackenzie
Copy link
Member

First iteration for #339. We can iterate on this if we like.

@elshize
Copy link
Member

elshize commented Apr 8, 2020

What do you think of merging "About" into "Readme"? Do we gain anything by having a separate file? I think there's an advantage to having the description show up right away to someone who's visiting the repo, especially for the first time. But it would be nice to have a little table of contents at the top... What do you think?

@JMMackenzie
Copy link
Member Author

Totally agree, I was just being conservative with it to be honest (as I didn't want to just nuke the README without consultation). Let's see what Antonio thinks, if he agrees then I will merge it all together.

@amallia
Copy link
Member

amallia commented Apr 9, 2020

I am okay with merging the ABOUT.md page with the README.md one.
I think it would be nice to have a usage example of PISA as a library, but we can add that later.

@JMMackenzie
Copy link
Member Author

@amallia @elshize okay, take a look now. I have merged the two pages.

@JMMackenzie JMMackenzie merged commit e28869f into master Apr 14, 2020
@JMMackenzie JMMackenzie deleted the describe-pisa branch April 14, 2020 11:26
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

Successfully merging this pull request may close these issues.

3 participants