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

Update README.md #1032

Merged
merged 3 commits into from
Mar 22, 2022
Merged

Update README.md #1032

merged 3 commits into from
Mar 22, 2022

Conversation

Clay-Mysten
Copy link
Contributor

Reduce logo size and wrap with intro text with HTML table at top

Reduce logo size and wrap with intro text with HTML table at top
Converting HTML table to Markdown now that image width is no issue

Welcome to Sui, a next generation smart contract platform with high throughput, low latency, and an asset-oriented programming model powered by the [Move](https://github.com/MystenLabs/awesome-move) programming language! Find everything you need within the [Sui Developer Guides](doc/src/learn/index.md) and supporting materials.
| | |
| ----------- | ----------- |
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
| ----------- | ----------- |

The first row in the table looks a bit funky:
image

Think this will fix it, but not sure.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sadly, that doesn't seem to work as that row appears to be the delimiter between table headings and regular rows. I removed it, and it rendered as:

| | | | Welcome to Sui, a next-generation smart contract platform with high throughput, low latency, and an asset-oriented programming model powered by the Move programming language! Find everything you need within the Sui Developer Guides and supporting materials below. |

I tried removing the top, empty row earlier but get this instead:

| ----------- | ----------- | | Welcome to Sui, a next-generation smart contract platform with high throughput, low latency, and an asset-oriented programming model powered by the Move programming language! Find everything you need within the Sui Developer Guides and supporting materials below. |

Looks like the heading is required by most parsers:
https://stackoverflow.com/questions/17536216/create-a-table-without-a-header-in-markdown

README.md Outdated
Welcome to Sui, a next generation smart contract platform with high throughput, low latency, and an asset-oriented programming model powered by the [Move](https://github.com/MystenLabs/awesome-move) programming language! Find everything you need within the [Sui Developer Guides](doc/src/learn/index.md) and supporting materials.
| | |
| ----------- | ----------- |
| Welcome to Sui, a next-generation smart contract platform with high throughput, low latency, and an asset-oriented programming model powered by the [Move programming language](https://github.com/MystenLabs/awesome-move)! Find everything you need within the [Sui Developer Guides](doc/src/learn/index.md) and supporting materials below. | ![Sui icon](doc/static/Sui_Icon_Brand.png) |
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • The icon still seems a bit big--maybe we should embed it in HTML + resize? e.g., <img src="doc/static/Sui_Icon_Brand.png" alt="sui_icon" width="200"/>
  • There's a lot of extra whitespace that hides the good README content that comes after the beginning. I'm not sure if that comes from the table or whitespace in the icon itself, but would be good to eliminate/minimize.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Heh, I went with HTML but converted to Markdown because I know Francois prefers it. Let me experiment.

Specify image width in HTML to reduce spacing
@Clay-Mysten Clay-Mysten requested a review from sblackshear March 22, 2022 19:11
Copy link
Collaborator

@sblackshear sblackshear left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Happy with this as-is, as I think it's an improvement over the giant image of today! We can always tweak later.

@Clay-Mysten Clay-Mysten merged commit 6e687aa into main Mar 22, 2022
@Clay-Mysten Clay-Mysten deleted the Clay-Mysten-patch-13 branch March 22, 2022 22:27
mwtian pushed a commit to mwtian/sui that referenced this pull request Sep 29, 2022
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