search

NCAR / CUPiD

CUPiD is a “one stop shop” that enables and integrates timeseries file generation, data standardization, diagnostics, and metrics from all CESM components.
https://ncar.github.io/CUPiD/
Apache License 2.0
21 stars 19 forks source link

Add 100x100 pixel logo to README #25

Closed mnlevy1981 closed 7 months ago

mnlevy1981 commented 7 months ago

Currently on the same line as the top header, but it may look better to put the logo on a line by itself?

Fixes #23

mnlevy1981 commented 7 months ago

To preview the README, click here; also including a screenshot:

README with logo

mnlevy1981 commented 7 months ago

The only other thought I had was to create a top-level docs/ directory and move logo.png to docs/images/logo.png, but I think it makes more sense to wait and see where we want the documentation to live / how we want it structured and then move the logo and update the source of the logo in the README file

TeaganKing commented 7 months ago

Are there other documentation structures that you think make more sense than a docs directory (and a wiki page)? I think we will probably be quickly adding more documentation, so it actually may not be a bad idea to have this directory structure set up already?

mnlevy1981 commented 7 months ago

I was picturing a docs/ directory that uses sphinx to build the full CUPiD documentation, which I don't think would be trivial to spin up. A simple webpage might be more appropriate, but in either case we probably want more code in the repository before we determine the best way to document it.

TeaganKing commented 7 months ago

Ok, sounds good! Yeah, sphinx can take a bit of work to set up...