Skip to content

Commit 10cca2c

Browse files
authored
Merge pull request #120 from eclipse-score/update_readme
update README
2 parents cc48423 + aa175da commit 10cca2c

File tree

1 file changed

+14
-11
lines changed

1 file changed

+14
-11
lines changed

README.md

Lines changed: 14 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -26,15 +26,6 @@ bazel run //process:incremental_latest
2626
bazel build //process:docs_latest
2727
```
2828

29-
#### Integrate latest score release
30-
31-
This should also work with proxy configuration if latest is not working.
32-
33-
```bash
34-
bazel run //process:incremental_release
35-
bazel build //process:docs_release
36-
```
37-
3829
#### Access your documentation at:
3930

4031
- `_build/` for incremental
@@ -45,8 +36,16 @@ bazel build //process:docs_release
4536
Create the virtual environment via `bazel run //process:ide_support`.\
4637
If your IDE does not automatically ask you to activate the newly created environment you can activate it.
4738

48-
- In VSCode via `ctrl+p` => `Select Python Interpreter` then select `.venv/bin/python`
49-
- In the terminal via `source .venv/bin/activate`
39+
- In VSCode via `ctrl+p` => `Select Python Interpreter` then select `.venv_docs/bin/python` OR
40+
- Click in the top level search bar, open `Show and Run Commands` => `Select Python Interpreter` then select `.venv_docs/bin/python`
41+
- In the terminal via `source .venv_docs/bin/activate`
42+
43+
Now run the live_preview commands
44+
45+
```bash
46+
bazel run //process:incremental_latest
47+
bazel run //process:live_preview_latest
48+
```
5049

5150
#### Format your documentation with:
5251

@@ -55,10 +54,14 @@ bazel test //:format.test
5554
bazel run //:format.fix
5655
```
5756

57+
Now server should be available with a preview on the link that is given (normally 127.0.0.1:8000) and the documentation can be previewed there.
58+
5859
#### Find & fix missing copyright
5960

6061
```bash
6162
bazel test //:copyright.test
6263
bazel run //:copyright.fix
6364
```
6465

66+
#### Explore more functions with
67+
bazel query //...

0 commit comments

Comments
 (0)