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.

Sign up for GitHub

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

Jump to bottom

First draft of the Documentation #13

Merged
merged 18 commits into from
Jul 29, 2020
Merged

First draft of the Documentation #13

merged 18 commits into from
Jul 29, 2020

Conversation

gparmer
Copy link
Collaborator

@gparmer gparmer commented Jul 27, 2020

Includes:

  • Breaking "testing" out into a separate section
  • Performance section
  • Comparison section
  • Design document in doc/design.md
  • "about us" added.

@gparmer gparmer requested review from geky, Others and phanikishoreg July 27, 2020 15:51
@gparmer gparmer mentioned this pull request Jul 27, 2020
Merged
@gparmer
Copy link
Collaborator Author

gparmer commented Jul 27, 2020

If you want to view the changes, see here.

phanikishoreg
phanikishoreg reviewed Jul 27, 2020
View reviewed changes
README.md Outdated Show resolved Hide resolved
phanikishoreg
phanikishoreg reviewed Jul 27, 2020
View reviewed changes
README.md Outdated Show resolved Hide resolved
phanikishoreg
phanikishoreg reviewed Jul 27, 2020
View reviewed changes
README.md Outdated Show resolved Hide resolved
phanikishoreg
phanikishoreg reviewed Jul 27, 2020
View reviewed changes
Copy link
Member

@phanikishoreg phanikishoreg left a comment

Choose a reason for hiding this comment

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

aWsm draft!! Thanks! Because it is open sourced, wondering if having sections on how to contribute as an outsider, or report issues (likely just raise issues in github repo) in the top-level README would benefit?

geky
geky approved these changes Jul 28, 2020
View reviewed changes
Copy link
Collaborator

@geky geky left a comment

Choose a reason for hiding this comment

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

It's looking great!

Some comments feel free to take or drop them.

README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
doc/design.md Outdated Show resolved Hide resolved
doc/design.md Outdated Show resolved Hide resolved
@gparmer
Copy link
Collaborator Author

gparmer commented Jul 28, 2020

Thanks for the feedback @geky and @phanikishoreg! If @Others doesn't have any requested changes, I'll apply this soon.

@gparmer
Copy link
Collaborator Author

gparmer commented Jul 28, 2020 •
edited
Loading

@phanikishoreg I agree that instrunctions on how to contribute would be useful. However, there are two most important steps before that:

  1. Get CI up and running. Until we have this, we can't practically accept much within a reasonable timespan.
  2. Get a PR template into here with the process.

See #15 #16 #17

I'd like to delay adding the instructions till we have these! I will add issues for both, however ;-)

Others
Others approved these changes Jul 28, 2020
View reviewed changes
Copy link
Contributor

@Others Others left a comment

Choose a reason for hiding this comment

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

Looks good to me, couple nits, but don't feel strongly about them

README.md Outdated Show resolved Hide resolved
doc/design.md Outdated

- Programming languages are compiled into Wasm, for example, using LLVM.
- Wasm has a binary representation and (as depicted) a s-expr representation.
- The aWsm compiler inputs this Wasm, generates LLVM IR corresponding to the Wasm.
Copy link
Contributor

Choose a reason for hiding this comment

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

Nit: binary wasm

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Updated in 4199351

@gparmer gparmer merged commit a344a65 into gwsystems:master Jul 29, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@geky geky geky approved these changes

@Others Others Others approved these changes

@phanikishoreg phanikishoreg phanikishoreg left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@gparmer @geky @Others @phanikishoreg