Skip to content

Commit

Permalink
README improvements (kaspanet#321)
Browse files Browse the repository at this point in the history
* README.md reformatted + logo

Added a logo and cleaned up the formatting for README.md for repo to look more appealing.

* Added table of contents

* Categorized README.me

* Removed confusing node setup

* Formatting

* Added language tag markdown

* Removed duplicate file

* kaspanet#321 - Refactored documentation

I have refactored the documentation and made the following changes:

* Wrapped most sections in <details> tag.
* Added multi-line code representation.
* Removed image.
* Prefixed linux commands with `sudo`

Co-Authored-By: coderofstuff <[email protected]>

* kaspanet#321 - Added a few more backslashes

Added backslashes to linux commands.

* Refactoring to reduce the amount of details tags used

* Removed detail tags

* Removed details tag from nextest and integration tests section

* Added introduction paragraph.

* Updated wording

* Rephrased sentence

* Refactored readme

I have made the following modifications:
* rephrased text
* removed heading alignment
* removed p2 and p3
* made linux general prerequisites in a single line

* Delete kaspa.png

---------

Co-authored-by: coderofstuff <[email protected]>
Co-authored-by: aspect <[email protected]>
  • Loading branch information
3 people authored Dec 10, 2023
1 parent 88ab9e2 commit c525961
Showing 1 changed file with 357 additions and 162 deletions.
Loading

0 comments on commit c525961

Please sign in to comment.