-
Notifications
You must be signed in to change notification settings - Fork 69
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
Improved setup instructions in README #1
Conversation
@@ -39,16 +39,52 @@ Before getting started, please see | |||
## Developing |
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.
Lets add this to the Contributing section:
If you wish to make contributions to XDMoD you will need to follow these steps:
- Fork the appropriate XDMoD repos
- Clone the repos onto your local system
- Develop and test
- Commit changes to your fork on Github
- Initiate a pull request for review by the XDMoD team
A list of supported XDMoD repos can be found at [XDMoD Repo manifest repository][xdmod-repo-manifest].
And also on the manifest page explicitly list the repos that are part of the XDMoD framework |
You need to include instructions about how to install on Centos 6 & 7. This OS has the version of php that doesn't do correct validation of ssl certs. The current instructions to run composer install fail out of the box on both OSes |
I did see some warning messages when building the RPMs as per these instructions: xdmod:
xdmod-supremm:
Suggest that we add some documentation somewhere that explains these are benign. This should help reduce some support requests. |
Update from latest changes
Update template and comments
Elevate chapter index files
Description
This updates the README file based on feedback from various XDMoD team members.
Motivation and Context
This will make getting started with Open XDMoD easier.
Tests performed
I checked that the new README file renders correctly on GitHub.
Types of changes
Checklist:
I have added tests to cover my changes.All new and existing tests passed.