From 6ffd233eea4d81da0ad35f758c94aef5f7c085b6 Mon Sep 17 00:00:00 2001 From: Kiko Fernandez Reyes Date: Fri, 6 May 2016 13:22:40 +0200 Subject: [PATCH] update documentation section in readme.md the current `README.md` states that the Encore documentation is in the upscale repo, which is wrong. this commit fixes this (fixes #405). --- README.md | 13 ++++--------- 1 file changed, 4 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index f2e9ede66..b99e7a2e1 100644 --- a/README.md +++ b/README.md @@ -215,18 +215,13 @@ Running `encorec foo.enc` will typecheck the source and produce the executable Update the language specification whenever you change the Encore compiler. -#### Dependencies +#### Generate documentation -In order to update the language specification, first you need to: +Generate the documentation and check your changes by typing: - 1. download the [Racket language](http://download.racket-lang.org/) - 2. clone the project upscale (https://github.com/fxpl/upscale) - 3. cd upscale/doc/encore - 4. make + - `make doc` -After following the instructions above, you should have a folder under -`upscale/doc/encore` named `build` that contains the documentation in -pdf and html. +After this, you should have a folder under `encore/doc/encore` named `build` that contains the documentation in pdf and html. #### Update the language specification