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

Improve project's heading in README #10

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Improve project's heading in README #10

wants to merge 1 commit into from

Conversation

Mec-iS
Copy link

@Mec-iS Mec-iS commented Sep 17, 2018

As a general approach is better to give some trail of the research that took to the idea. Without some references to existing work at hand, it is pretty difficult to navigate the subject.

An extract from WA doc:

Non-Web environments may provide different APIs than Web environments, which feature testing and dynamic linking will make discoverable and usable.

Are these lines relevant for the scope of cwa? I added an "objectives" paragraph to collect these useful cross-references.

In practice, I provided a better rooted heading for the happiness of everybody!

cc @Xe

README.md Outdated
The Common WebAssembly API is a minimal specification of the standard API for non-Web WebAssembly usermode environments.
## The project

Common WebAssembly API (CWA) is a minimal specification of a standard API to implement [non-Web](https://webassembly.org/docs/non-web/) WebAssembly in virtualized environments by leveraging [User Mode Linux](http://user-mode-linux.sourceforge.net/).
Copy link
Contributor

Choose a reason for hiding this comment

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

User Mode Linux isn't relevant though?

@Mec-iS
Copy link
Author

Mec-iS commented Sep 18, 2018

Changes applied.


## Objectives

<sup>TODO: add how the project's objectives are inspired by WA official doc about "non-Web" WebAssembly ecosystem (with quotations)</sup>
Copy link
Contributor

Choose a reason for hiding this comment

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

This does sound like a @losfair thing

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.

None yet

2 participants