Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update documentation section in readme.md #406

Merged
merged 1 commit into from
May 10, 2016

Conversation

kikofernandez
Copy link
Contributor

the current README.md states that the Encore documentation is in the
upscale repo, which is wrong.

Language Specification

Update the language specification whenever you change the Encore compiler.

Dependencies

In order to update the language specification, first you need to:

  1. download the Racket language
  2. clone the project upscale (https://github.com/fxpl/upscale)
  3. cd upscale/doc/encore
  4. make

After following the instructions above, you should have a folder under
upscale/doc/encore named build that contains the documentation in
pdf and html.

the current `README.md` states that the Encore documentation is in the
upscale repo, which is wrong. this commit fixes this (fixes #405).

In order to update the language specification, first you need to:
Generate the documentation and check your changes by typing:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What does "check your changes" mean in this context?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I meant that you need to check that the added documentation looks good (specially when extending the syntax tree using racket code)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, ok!

@EliasC EliasC merged commit 68dd4ec into parapluu:development May 10, 2016
@kikofernandez kikofernandez deleted the fix/readme branch May 21, 2016 06:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants