search

intel / rohd

The Rapid Open Hardware Development (ROHD) framework is a framework for describing and verifying hardware in the Dart programming language.
https://intel.github.io/rohd-website
BSD 3-Clause "New" or "Revised" License
374 stars 67 forks source link

Refactor docs and README for website #388

Closed mkorbel1 closed 1 year ago

mkorbel1 commented 1 year ago

Description & Motivation

As we move to using the ROHD Website as the main landing area, this PR migrates most of the README into separate documents for the website. Mostly this is deleting stuff from README and including updates from it into the changes from #359.

Related Issue(s)

Fix #374

Testing

CI should catch things, will also test with rohd-website fork

Backwards-compatibility

Is this a breaking change that will not be backwards-compatible? If yes, how so?

No

Documentation

Does the change require any updates to documentation? If so, where? Are they included?

Only docs

quekyj commented 1 year ago

The readme is good. But do you think that we should add more details like a reference to the tutorials / bootcamp or the upcoming blog? Make it more user friendly by listing some of the features on the website. Maybe also link the installation page to the website in the readme? I think we can follow what flutter did on their page https://github.com/flutter/flutter.