Skip to content

ReWrite README and update Github Pages #41

Description

@Nayggets

Rewrite README & Update GitHub Pages

Rewrite the README

The current README.md should be rewritten to improve readability and better present the project.

Tasks

  • Update the list of dependencies and their required versions.
  • Remove outdated information.
  • Improve the installation and usage instructions.
  • Add an Experiments & Results section describing the experiment methodology and presenting the associated performance results.

Update GitHub Pages

Create a modern GitHub Pages website to showcase HybroGen.

The website should be designed for industrial partners, researchers, students, and new contributors.

It should present:

  • What HybroGen is.
  • How it works.
  • How to install and use it.
  • The supported architectures.
  • Experiments and benchmark results.

Huge improvement

The website should be automatically updated by the CI whenever new benchmark results are available.

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentationenhancementNew feature or request

Type

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions