|
24 | 24 | ## Contents:
|
25 | 25 |
|
26 | 26 | * [Installing and running](#installing)
|
27 |
| -* [Building](#building) |
28 | 27 | * [Customisation](#customisation)
|
| 28 | +* [Building](#building) |
29 | 29 | * [Contributing](#contributing)
|
30 | 30 |
|
31 | 31 | ### Screen shots
|
@@ -64,6 +64,30 @@ This may take some time (depending on your crate, up to twice as long as a norma
|
64 | 64 | build). You can browse the source in whilst indexing, but you'll be missing all
|
65 | 65 | the good stuff like jump-to-def and search.
|
66 | 66 |
|
| 67 | + |
| 68 | +## Customisation |
| 69 | + |
| 70 | +Create a `rustw.toml` file in your project's directory. See [src/config.rs](src/config.rs) |
| 71 | +or run `cargo src -- -h` for the options available and their defaults. |
| 72 | + |
| 73 | +Some features **need** configuration in the rustw.toml before they can be |
| 74 | +used. |
| 75 | + |
| 76 | +``` |
| 77 | +edit_command = "subl $file:$line" |
| 78 | +``` |
| 79 | + |
| 80 | +To be able to open files in your local editor. This example works for sublime |
| 81 | +text (`subl`). Use the `$file` and `$line` variables as appropriate for your |
| 82 | +editor. |
| 83 | + |
| 84 | +``` |
| 85 | +vcs_link = "https://github.com/nrc/rustw-test/blob/master/$file#L$line" |
| 86 | +``` |
| 87 | + |
| 88 | +For links to the code in version control, GitHub, in the example. |
| 89 | + |
| 90 | + |
67 | 91 | ## Building and running
|
68 | 92 |
|
69 | 93 | Requires a nightly version of Rust.
|
@@ -127,30 +151,6 @@ On MacOS:
|
127 | 151 | export DYLD_LIBRARY_PATH=$(rustc --print sysroot)/lib:$DYLD_LIBRARY_PATH
|
128 | 152 | ```
|
129 | 153 |
|
130 |
| - |
131 |
| -## Customisation |
132 |
| - |
133 |
| -Create a `rustw.toml` file in your project's directory. See [src/config.rs](src/config.rs) |
134 |
| -or run `cargo src -- -h` for the options available and their defaults. |
135 |
| - |
136 |
| -Some features **need** configuration in the rustw.toml before they can be |
137 |
| -properly used. |
138 |
| - |
139 |
| -``` |
140 |
| -edit_command = "subl $file:$line" |
141 |
| -``` |
142 |
| - |
143 |
| -To be able to open files in your local editor. This example works for sublime |
144 |
| -text (`subl`). Use the `$file` and `$line` variables as appropriate for your |
145 |
| -editor. |
146 |
| - |
147 |
| -``` |
148 |
| -vcs_link = "https://github.com/nrc/rustw-test/blob/master/$file#L$line" |
149 |
| -``` |
150 |
| - |
151 |
| -For links to the code in version control. |
152 |
| - |
153 |
| - |
154 | 154 | ## Contributing
|
155 | 155 |
|
156 | 156 | Cargo src is open source (dual-licensed under the Apache 2.0 and MIT licenses)
|
|
0 commit comments