Skip to content

Commit

Permalink
new updates to README.md in /contrib
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
mcprentiss committed Feb 6, 2015
1 parent 831cdc8 commit f07c626
Showing 1 changed file with 43 additions and 33 deletions.
76 changes: 43 additions & 33 deletions contrib/README.md
Original file line number Diff line number Diff line change
@@ -1,33 +1,43 @@
Julia Config directory README
=============================

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"
filterDupLibs.sh - script to filter out duplicate libraries
fixup-libgfortran.sh - Include libgfortran and libquadmath for installations
install.sh - installation script with different permissions
install-tmbundle - TextMate bundle install script
julia.appdata.xml - Appdata config file
julia.desktop - GNOME desktop config file
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.svg - julia svg image file
Julia.tmbundle/ - TextMate support files
julia.xml - KDE editors Kate and Kwrite config file
mac/ - Mac install files
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
relative_path.sh - convert absolute path into relative path script
repackage_system_suitesparse4.make - reinstall_suitesparse4 script
stringreplace.c - Cygwin helper script
vagrant/ - portable development environment Vagrant install files
windows/ - windows install files
Installation
=============================

| Name | Description |
| ---------------------------- | --------------------------------------------------------- |
|[ build_executable.jl ](https://github.com/JuliaLang/julia/blob/master/contrib/build_executable.jl) | Support building standalone executables |
|[ build_sysimg.jl ](https://github.com/JuliaLang/julia/blob/master/contrib/build_sysimg.jl) | Build a system image binary |
|[ check-whitespace.sh ](https://github.com/JuliaLang/julia/blob/master/contrib/check-whitespace.sh) | Check for trailing white space |
|[ filterDupLibs.sh ](https://github.com/JuliaLang/julia/blob/master/contrib/filterDupLibs.sh) | script to filter out duplicate libraries |
|[ fixup-libgfortran.sh ](https://github.com/JuliaLang/julia/blob/master/contrib/fixup-libgfortran.sh) | Include libgfortran and libquadmath for installations |
|[ fixup-libstdc++.sh ](https://github.com/JuliaLang/julia/blob/master/contrib/fixup-libstdc++.sh) | Include libstdc++ for installations |
|[ install.sh ](https://github.com/JuliaLang/julia/blob/master/contrib/install.sh) | installation script with different permissions |
|[ julia.appdata.xml ](https://github.com/JuliaLang/julia/blob/master/contrib/julia.appdata.xml) | Appdata config file |
|[ julia.desktop ](https://github.com/JuliaLang/julia/blob/master/contrib/julia.desktop) | GNOME desktop config file |
|[ julia.svg ](https://github.com/JuliaLang/julia/blob/master/contrib/julia.svg) | julia svg image file |
|[ mac/ ](https://github.com/JuliaLang/julia/blob/master/contrib/mac/) | Mac install files |
|[ relative_path.sh ](https://github.com/JuliaLang/julia/blob/master/contrib/relative_path.sh) | convert absolute path into relative path script |
|[ stringreplace.c ](https://github.com/JuliaLang/julia/blob/master/contrib/stringreplace.c) | replace strings to hardcoded paths in binaries during `make install` |
|[ vagrant/ ](https://github.com/JuliaLang/julia/blob/master/contrib/vagrant/) | portable development environment Vagrant install files |
|[ windows/ ](https://github.com/JuliaLang/julia/blob/master/contrib/windows/) | windows install files |

Editors + Debuggers
=============================

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

0 comments on commit f07c626

Please sign in to comment.