28
28
* [ Building] ( #building )
29
29
* [ Contributing] ( #contributing )
30
30
31
- ### Screen shots
31
+ ### Screenshots
32
32
33
33
![ cargo src screenshot - source view] ( overview.png )
34
34
49
49
![ cargo src screenshot - source view] ( right-click.png )
50
50
51
51
52
- ## Installing and running
52
+ ## < a id = " installing " ></ a > Installing and running
53
53
54
54
Requires a nightly version of Rust.
55
55
@@ -65,7 +65,7 @@ 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
67
68
- ## Customisation
68
+ ## < a id = " customisation " ></ a > Customisation
69
69
70
70
Create a ` rustw.toml ` file in your project's directory. See [ src/config.rs] ( src/config.rs )
71
71
or run ` cargo src -- -h ` for the options available and their defaults.
@@ -88,33 +88,15 @@ vcs_link = "https://github.com/nrc/rustw-test/blob/master/$file#L$line"
88
88
For links to the code in version control, GitHub, in the example.
89
89
90
90
91
- ## Building and running
91
+ ## < a id = " building " ></ a > Building
92
92
93
93
Requires a nightly version of Rust.
94
94
95
95
Get the source code from https://github.com/nrc/cargo-src .
96
96
97
- * setup the React/webpack environment (requires npm):
98
- ``` sh
99
- npm install
100
-
101
- # if you have yarn installed:
102
-
103
- yarn
104
-
105
- # if not:
106
-
107
- npm install --save react react-dom
108
- npm install --save react-treebeard
109
- npm install --save-dev babel-loader babel-core
110
- npm install --save-dev babel-preset-react
111
- npm install --save-dev babel-preset-es2015
112
- npm install --save-dev babel-plugin-transform-object-rest-spread
113
- npm install --save-dev webpack
114
- npm install --save-dev immutable
115
- ```
116
- * build the JS components: ` npm run build ` or ` yarn build `
117
- * ` cargo build --release ` to build the Rust parts.
97
+ * Install the dependencies: ` npm install ` or ` yarn `
98
+ * Build the JS components: ` npm run build ` or ` yarn build `
99
+ * Build the Rust parts: ` cargo build --release `
118
100
119
101
### Running
120
102
@@ -151,7 +133,7 @@ On MacOS:
151
133
export DYLD_LIBRARY_PATH=$(rustc --print sysroot)/lib:$DYLD_LIBRARY_PATH
152
134
```
153
135
154
- ## Contributing
136
+ ## < a id = " contributing " ></ a > Contributing
155
137
156
138
Cargo src is open source (dual-licensed under the Apache 2.0 and MIT licenses)
157
139
and contributions are welcome! You can help by testing and
0 commit comments