Location via proxy:   [ UP ]  
[Report a bug]   [Manage cookies]                
Skip to content

Commit 260aa43

Browse files
committed
LICENSE and README
1 parent 5520b33 commit 260aa43

File tree

2 files changed

+42
-0
lines changed

2 files changed

+42
-0
lines changed

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
The MIT License (MIT)
2+
3+
Copyright (c) 2022-present Kevin Newton
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in
13+
all copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21+
THE SOFTWARE.

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# ruby-syntax-tree.github.io
2+
3+
This repository contains the code that backs <ruby-syntax-tree.github.io>. It is an interactive editor that is running [Syntax Tree](https://github.com/ruby-syntax-tree/syntax_tree) in the background to handle introspecting the underlying syntax tree and formatting. It uses Ruby's WASI bindings to do this all in the browser.
4+
5+
## Getting started
6+
7+
To run the application locally, you should:
8+
9+
* `bundle install` to install the Ruby dependencies.
10+
* `yarn install` to install the node dependencies.
11+
* `bundle exec rake` to build the `.wasm` application file.
12+
* `yarn serve` to start the local development server.
13+
* Open a browser at `localhost:8000`.
14+
15+
## Contributing
16+
17+
Bug reports and pull requests are welcome on GitHub at https://github.com/ruby-syntax-tree/syntax_tree.
18+
19+
## License
20+
21+
The repository is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

0 commit comments

Comments
 (0)