-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
24ee720
commit 9bee95e
Showing
1 changed file
with
40 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
# Spark Engine Web | ||
|
||
Spark Engine Web is a lightweight browser based web engine we are building for fun. | ||
|
||
We are building the engine with Security and performance in mind, to provide the best possible experience to our engine's users and contributors. | ||
|
||
That being said, it will be an iterative journey and we won't bump the major version until we will feel confident to have reached our goal. | ||
|
||
## Getting Started | ||
|
||
**Requirements** | ||
|
||
* Node ^18 | ||
* NPM ^9 | ||
|
||
Run `npm i` to install packages. After that, you are good to go | ||
|
||
### Commands | ||
|
||
* `npm test` to run the test suite | ||
* `npm run build` to build the engine | ||
* `npm run clean` to clean the dist folder | ||
|
||
## Usage | ||
|
||
TBD | ||
|
||
## Contributing | ||
|
||
To contribute to the project just open a pull request. If you are working on an existing issue remember to link the pull request to it. | ||
|
||
Once opened a core maintinaer will review the PR and eventually approve it | ||
|
||
## License | ||
|
||
See [LICENSE](./LICENSE) file | ||
|
||
## Contact | ||
|
||
See maintainers section in package.json |