Skip to content

Commit 7d6fed3

Browse files
committed
Updated readme to reflect changes.
1 parent 3f20d6c commit 7d6fed3

File tree

1 file changed

+9
-6
lines changed

1 file changed

+9
-6
lines changed

README.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,10 @@ original V [docs.md](https://github.com/vlang/v/blob/master/doc/docs.md)
77

88
## External dependencies
99

10-
You'll need V, of course. Best to
10+
This project only requires V. Best to
1111
[install it from source](https://github.com/vlang/v?tab=readme-ov-file#installing-v-from-source)
1212
if you don't already have it.
1313

14-
Make sure you have [sass](https://sass-lang.com/install/) installed
15-
locally to build the css files.
16-
1714

1815
## Contributing
1916
To setup the generator and contribute changes to it, do this once:
@@ -31,14 +28,20 @@ To build the documentation, after the setup, run the following commands:
3128
```shell
3229
v run .
3330
```
34-
This will download the latest version
31+
This will download the latest version
3532
of [docs.md](https://github.com/vlang/v/edit/master/doc/docs.md),
3633
then it will regenerate the documentation from it, and save it in the `output`
3734
directory.
3835

3936

4037
## Testing the output
38+
39+
Use V to serve your local copy of the documentation.
40+
4141
```shell
4242
v -e 'import net.http.file; file.serve(folder: "output/")'
4343
```
44-
Now load http://localhost:4001/ in your browser.
44+
45+
The line of code executed will start a basic web server with the documentation created in the "outputs" folder.
46+
47+
Access the documentation on your browser using this url http://localhost:4001/.

0 commit comments

Comments
 (0)