Skip to content
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

Merged
merged 2 commits into from
Feb 6, 2015
Merged

add README.md for contrib directory #10014

merged 2 commits into from
Feb 6, 2015

Conversation

mcprentiss
Copy link
Contributor

This is not important but having a README.md in the config contrib 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.

@jiahao
Copy link
Member

jiahao commented Feb 2, 2015

+1

Perhaps a table?

@mcprentiss
Copy link
Contributor Author

sure. something like...

Julia Config directory README

Name Description
ackrc config for Ack
BBEditTextWrangler-julia.plist language module for BBEdit and TextWrangler text editors
build_executable.jl Support building standalone executables
build_sysimg.jl Build a system image binary
check-whitespace.sh Check for trailing white space
ctags Add more keywords to ctags regex
debug_bootstrap.gdb bootstrap process using the debug build
filterArgs.sh Update library search code to use only tokens that start with "-L"

@ViralBShah
Copy link
Member

How about separate out sections, so that the editor files are in a section by themselves?

@mcprentiss
Copy link
Contributor Author

okay here is version 2,
they divided pretty cleanly between installation things and editors/debugging tools.

Installation

Name Description
build_executable.jl Support building standalone executables
build_sysimg.jl Build a system image binary
check-whitespace.sh Check for trailing white space
filterDupLibs.sh script to filter out duplicate libraries
fixup-libgfortran.sh Include libgfortran and libquadmath for installations
install.sh installation script with different permissions
julia.appdata.xml Appdata config file
julia.desktop GNOME desktop config file
julia.svg julia svg image file
mac/ Mac install files
relative_path.sh convert absolute path into relative path script
stringreplace.c Cygwin helper script
vagrant/ portable development environment Vagrant install files
windows/ windows install files

Editors + Debuggers

Name Description
ackrc config for Ack search tool
BBEditTextWrangler-julia.plist language module for BBEdit and TextWrangler text editors
ctags Add more keywords to ctags regex search tool
debug_bootstrap.gdb bootstrap process using the debug build
filterArgs.sh Update library search code to use only tokens that start with "-L"
install-tmbundle TextMate bundle install script
julia.hrc Julia syntax highlighting definition for Colorer
julia.lang GtkSourceView (GTK+ framework) for multiline text editing config file
julia-mode.el Emacs Julia mode config file
Julia_Notepad++.xml Notepad++ config file
Julia.tmbundle/ TextMate support files
julia.xml KDE editors Kate and Kwrite config file
Notepad++_2_Julia.ahk Auto Hotkey for Notepad++ config file
README.ackrc.txt README for ackrc config file
README.ctags.txt README for ctags config file
repackage_system_suitesparse4.make reinstall_suitesparse4 script
valgrind-julia.supp support for Valgrind debugging tool

@ivarne
Copy link
Sponsor Member

ivarne commented Feb 2, 2015

+1 for that sectioned table. Can you manage clickable links for download

Editors + Debuggers

Name Description
ackrc (raw) config for Ack search tool
BBEditTextWrangler-julia.plist (raw) language module for BBEdit and TextWrangler text editors
ctags (raw) Add more keywords to ctags regex search tool

I'm not sure the (raw) links is worth the typing effort. Github features them pretty well on the main page. If you use a script to generate the readme, that would be great to include as well.

@nalimilan
Copy link
Member

Just a note about the name of the commit: the directory is called contrib, not config. I was really confused about the title of this PR. :-)

@ivarne ivarne changed the title add README.md for config directory add README.md for contrib directory Feb 2, 2015
@mcprentiss
Copy link
Contributor Author

@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?

@mcprentiss
Copy link
Contributor Author

Here goes. I think this is a converged version.

Installation

Name Description
build_executable.jl Support building standalone executables
build_sysimg.jl Build a system image binary
check-whitespace.sh Check for trailing white space
filterDupLibs.sh script to filter out duplicate libraries
fixup-libgfortran.sh Include libgfortran and libquadmath for installations
install.sh installation script with different permissions
julia.appdata.xml Appdata config file
julia.desktop GNOME desktop config file
julia.svg julia svg image file
mac/ Mac install files
relative_path.sh convert absolute path into relative path script
stringreplace.c Cygwin helper script
vagrant/ portable development environment Vagrant install files
windows/ windows install files

Editors + Debuggers

Name Description
ackrc config for Ack search tool
BBEditTextWrangler-julia.plist language module for BBEdit and TextWrangler text editors
ctags Add more keywords to ctags regex search tool
debug_bootstrap.gdb bootstrap process using the debug build
filterArgs.sh Update library search code to use only tokens that start with -L
install-tmbundle TextMate bundle install script
julia.hrc Julia syntax highlighting definition for Colorer
julia.lang GtkSourceView (GTK+ framework) for multiline text editing config file
julia-mode.el Emacs Julia mode config file
Julia_Notepad++.xml Notepad++ config file
Julia.tmbundle/ TextMate support files
julia.xml KDE editors Kate and Kwrite config file
Notepad++_2_Julia.ahk Auto Hotkey for Notepad++ config file
README.ackrc.txt README for ackrc config file
README.ctags.txt README for ctags config file
repackage_system_suitesparse4.make reinstall_suitesparse4 script
valgrind-julia.supp support for Valgrind debugging tool

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
Copy link
Contributor

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.
@mcprentiss
Copy link
Contributor Author

@jiahao @ViralBShah @tkelman I think this is ready to go. I made the required fixes.

ivarne added a commit that referenced this pull request Feb 6, 2015
add README.md for contrib directory
@ivarne ivarne merged commit 372672d into JuliaLang:master Feb 6, 2015
@ivarne
Copy link
Sponsor Member

ivarne commented Feb 6, 2015

Thanks for doing this!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

6 participants