Skip to content

Commit 9e76301

Browse files
committed
fix(doc): Update README and instructions for building documentation
Signed-off-by: Jerome Simeon <[email protected]>
1 parent 4c48467 commit 9e76301

File tree

4 files changed

+13
-13
lines changed

4 files changed

+13
-13
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -208,7 +208,7 @@ $ cd bin; java -jar javaService.jar -server 9879
208208

209209
Code documentation and background information, notably references for all supported languages, can be found on the Q\*cert Web site: https://querycert.github.io
210210

211-
If you want to re-generated the documentation from the source itself, you will need to install [coq2html](https://github.com/xavierleroy/coq2html). Detailed instructions are provided in [doc/README.md](doc/README.md)
211+
If you want to re-generated the documentation from the source itself, you will need to install [coq2html](https://github.com/xavierleroy/coq2html). Detailed instructions are provided in [doc/README.md](documentation/README.md)
212212

213213
## Using Q\*cert
214214

@@ -383,11 +383,6 @@ $ java -cp runtimes/java/bin:bin/*:bin/lib/*:tests/oql testing.runners.RunJava \
383383
```
384384

385385

386-
### Cloudant Target
387-
388-
TO BE WRITTEN
389-
390-
391386
### Spark RDDs Target
392387

393388
TO BE WRITTEN
@@ -404,6 +399,11 @@ $ run.sh
404399
```
405400

406401

402+
### WASM Target
403+
404+
TO BE WRITTEN
405+
406+
407407
## Caveats
408408

409409
- There is no official support for Windows, although some success has been reported using Cygwin

compiler/core/Translation/Lang/JavaScriptAsttoJavaScript.v

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -391,7 +391,7 @@ Section ToString.
391391
(f:funcdecl)
392392
(i: nat) (* indentation level *)
393393
: string :=
394-
(* XXX All methods are declare as static *)
394+
(* All methods are declared as static *)
395395
eol ++ indent i ++ "static " ++ f.(funcdecl_name) ++ "(" ++ (comma_list f.(funcdecl_parameters)) ++ ") {" ++ eol
396396
++ string_of_funcbody f.(funcdecl_body) (i+1) ++ eol ++ indent i ++ "}"
397397
.

documentation/Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ CP=cp
2020

2121
## Deploy documentation
2222
all:
23-
make -C ../compiler/core documentation
23+
make -C .. docs
2424

2525
deploy:
2626
$(CP) qcertsite.css $(QUERYCERTDOTIO)

documentation/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -35,14 +35,14 @@ Then from the top-level `qcert` direcory, do:
3535

3636
```
3737
make qcert
38-
make documentation
38+
make docs
3939
```
4040

41-
This will regenerate the `doc/html` directory
41+
This will regenerate the `documentation/html` directory
4242

4343
# To update the compilation pipeline
4444

45-
Edit the LaTeX file `doc/figure/compiler-coq.tex`, then do:
45+
Edit the LaTeX file `documentation/figure/compiler-coq.tex`, then do:
4646

4747
```
4848
cd figure
@@ -52,12 +52,12 @@ make
5252
# To re-deploy the demo and documentation
5353

5454
To deploy the demo and new documentation to the external Q*cert Web
55-
site, first check that the `QUERYCERTDOTIO` in `doc/Makefile` has the
55+
site, first check that the `QUERYCERTDOTIO` in `documentation/Makefile` has the
5656
right location for your git checkout of the `querycert.github.io`
5757
project. By default, it's assumed to be checked out from github as a
5858
sibbling of the `qcert` repository.
5959

60-
Then from the `doc` directory, do:
60+
Then from the `documentation` directory, do:
6161
```
6262
make deploy
6363
```

0 commit comments

Comments
 (0)