-
Notifications
You must be signed in to change notification settings - Fork 171
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
Readme installation #5679
Readme installation #5679
Conversation
The build and test suite have started for your pull request. To view your build log, please reference the build with source version: "PR_5679". Additionally, check the latest "dev" source version to identify existing test failures. Please note that you are not responsible for the test failures that exist on both your PR and the dev branch. |
The build and test suite have started for your pull request. To view your build log, please reference the build with source version: "PR_5679". Additionally, check the latest "dev" source version to identify existing test failures. Please note that you are not responsible for the test failures that exist on both your PR and the dev branch. |
We can just change the logo like that, it would need to get reviewed by others first. I would argue to return it back to what it was and if we want to change it we can do something to update logos as a whole since some libraries might need ones. |
The build and test suite have started for your pull request. To view your build log, please reference the build with source version: "PR_5679". Additionally, check the latest "dev" source version to identify existing test failures. Please note that you are not responsible for the test failures that exist on both your PR and the dev branch. |
Changed logo back. The reason to consider a different one is readability. In the old logo, the ISIS text and the image behind are right on top of each other, and have a lot of intersecting lines between them, which limits readability. I changed it to brown for the ISIS docs to get better contrast, which helps but doesn't solve the root readability issue. |
@jrcain-usgs even if there are good reasons we need to have a conversation about these changes before they are worked, let alone merged. I would recommend also removing the logo from the PR. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
just some comments
README.md
Outdated
is similar to the best practice usage of not adding any conda | ||
packages to your 'base' conda environment. | ||
- [Building ISIS](https://astrogeology.usgs.gov/docs/how-to-guides/isis-developer-guides/developing-isis3-with-cmake/) | ||
- [ISIS Test Data](https://astrogeology.usgs.gov/docs/how-to-guides/isis-developer-guides/obtaining-maintaining-submitting-test-data/) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We need something that is a more general "this is how you run ISIS tests" not just how to install isis test data. Those linked docs cover it but maybe name this link "'How to run ISIS tests"
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"How to run ISIS Tests" is currently under the "Building ISIS" Doc. Here's a small PR to link to "ISIS Test Data" from "Building ISIS." And with that, I can safely remove the ISIS Test Data link from the README.
The build and test suite have started for your pull request. To view your build log, please reference the build with source version: "PR_5679". Additionally, check the latest "dev" source version to identify existing test failures. Please note that you are not responsible for the test failures that exist on both your PR and the dev branch. |
The build and test suite have started for your pull request. To view your build log, please reference the build with source version: "PR_5679". Additionally, check the latest "dev" source version to identify existing test failures. Please note that you are not responsible for the test failures that exist on both your PR and the dev branch. |
Reorganized the info in ISIS readme, moving some important info to ASC Docs, editing for conciseness, and removing unnecessary and overly verbose sections.
View proposed new README
Description
Extracted the Following Sections, moving each to its own ASC Doc page:
Condensed sections remaining on README for now:
Updated section:
Related Issue
Fixes #5500
Fixes #5650
How Has This Been Validated?
Readme previewed via VS Code markdown preview rendering.
Types of changes
Checklist:
Licensing
This project is mostly composed of free and unencumbered software released into the public domain, and we are unlikely to accept contributions that are not also released into the public domain. Somewhere near the top of each file should have these words: