Skip to content

Commit 1d1fd33

Browse files
committed
Update the README
1 parent 557da07 commit 1d1fd33

File tree

1 file changed

+25
-25
lines changed

1 file changed

+25
-25
lines changed

README.md

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,8 @@ edges.
2424
## Contents:
2525

2626
* [Installing and running](#installing)
27-
* [Building](#building)
2827
* [Customisation](#customisation)
28+
* [Building](#building)
2929
* [Contributing](#contributing)
3030

3131
### Screen shots
@@ -64,6 +64,30 @@ This may take some time (depending on your crate, up to twice as long as a norma
6464
build). You can browse the source in whilst indexing, but you'll be missing all
6565
the good stuff like jump-to-def and search.
6666

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+
6791
## Building and running
6892

6993
Requires a nightly version of Rust.
@@ -127,30 +151,6 @@ On MacOS:
127151
export DYLD_LIBRARY_PATH=$(rustc --print sysroot)/lib:$DYLD_LIBRARY_PATH
128152
```
129153

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-
154154
## Contributing
155155

156156
Cargo src is open source (dual-licensed under the Apache 2.0 and MIT licenses)

0 commit comments

Comments
 (0)