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

Docs: Update README.md to be more concise #6099

Merged
merged 3 commits into from
Oct 22, 2024
Merged

Conversation

Pcharlesme
Copy link
Contributor

@Pcharlesme Pcharlesme commented Aug 10, 2024

Summary

Styling and formatting updates for the main README.

Test Plan

N/A

@CLAassistant
Copy link

CLAassistant commented Aug 10, 2024

CLA assistant check
All committers have signed the CLA.

Copy link

codecov bot commented Aug 10, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 56.29%. Comparing base (23a04c2) to head (9effa77).
Report is 42 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #6099      +/-   ##
==========================================
+ Coverage   56.25%   56.29%   +0.04%     
==========================================
  Files         490      490              
  Lines       69699    69699              
==========================================
+ Hits        39206    39237      +31     
+ Misses      27825    27804      -21     
+ Partials     2668     2658      -10     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@gmalouf
Copy link
Contributor

gmalouf commented Sep 5, 2024

Hi @Pcharlesme ,

Appreciate the work put in here. We will not be adding/accepting a logo at this time to be included in the project. if you want to strip that content out, we can probably get this PR to be mergeable.

@gmalouf
Copy link
Contributor

gmalouf commented Sep 5, 2024

Also important to flesh out the PR description of notable changes made.

Copy link
Contributor

@algorandskiy algorandskiy left a comment

Choose a reason for hiding this comment

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

Agreed with Gary - that external logo is no-goer. Textural changes look OK tho.

@Pcharlesme
Copy link
Contributor Author

@algorandskiy @gmalouf Thanks for your feedback
Modification has been made as requested
Notable changes are
Detailed Node Running Instructions , Test Section
Detailed Sections on Interfacing, Deployment, and Utilities:

README.md Outdated Show resolved Hide resolved
@gmalouf gmalouf changed the title Update README.md to be more concise Docs: Update README.md to be more concise Sep 18, 2024
@gmalouf
Copy link
Contributor

gmalouf commented Sep 19, 2024

@Pcharlesme try rebasing to get latest from master/get build passing. README itself is looking good

@gmalouf gmalouf dismissed algorandskiy’s stale review October 22, 2024 19:26

Logo has been removed.

@gmalouf gmalouf merged commit 39f7485 into algorand:master Oct 22, 2024
19 of 22 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants