-
-
Notifications
You must be signed in to change notification settings - Fork 5.4k
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
add README.md for contrib directory #10014
Conversation
+1 Perhaps a table? |
sure. something like... Julia Config directory README
|
How about separate out sections, so that the editor files are in a section by themselves? |
okay here is version 2, Installation
Editors + Debuggers
|
+1 for that sectioned table. Can you manage clickable links for download Editors + Debuggers
I'm not sure the |
Just a note about the name of the commit: the directory is called |
@ivarne @nalimilan Thanks I was doing this during the Super Bowl, so I am pleased there aren't more errors. Adding links, etc would hurt the readability of the text file. Should I not be worried about it? |
Here goes. I think this is a converged version. Installation
Editors + Debuggers
|
README.ctags.txt - README for ctags config file | ||
relative_path.sh - convert absolute path into relative path script | ||
repackage_system_suitesparse4.make - reinstall_suitesparse4 script | ||
stringreplace.c - Cygwin helper script |
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.
This isn't for Cygwin, we use it everywhere during make install
. It's to replace strings to hardcoded paths in binaries. It just has a limited history with the current file name, it used to be called stringpatch but Windows does funny things with admin rights and 32-bit executables that have "patch" or "install" in their names. Here's the history of the file at its old name: https://github.com/JuliaLang/julia/commits/b42d5807cfbae15e520dcf23c3eff32addb3e437/contrib/stringpatch.c
Added links, added fixup-libstdc++.sh, separated into INSTALLATION, and EDITOR and DEBUGGING sections, fixed description of stringreplace.c. I think this is read to merge.
@jiahao @ViralBShah @tkelman I think this is ready to go. I made the required fixes. |
add README.md for contrib directory
Thanks for doing this! |
This is not important but having a README.md in the
configcontrib directory would be helpful.There is a lot of good stuff in here but it is a bit hard to find.
The formatting can be improved and made more beautiful, but this is a start.