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

Revise README.md #3

Merged
merged 1 commit into from
Aug 7, 2020
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 5 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,23 +12,19 @@ is potentially incompatible with Trusted Types, tsec emits compilation errors.
tsec is based on the open source TypeScript static analyzer
[Tsetse](https://tsetse.info/).

## Build and run
## Build and Run

### Build
```
# Clone the repository
git clone https://github.com/googleinterns/tsec
cd tsec

# Install gulp
npm install gulp

# Install dependencies
npm install

# Run a compile based on tsconfig.json
node_modules/typescript/bin/tsc


# Build
npm run build
```

### Run
Expand All @@ -37,4 +33,4 @@ To run a check for the compatibility with Trusted Types in the project containin
```
{PATH_TO_TSEC}/bin/tsec -p tsconfig.json
```
Add `--no-Emit` flag to skip the output from compilation.
Add `--noEmit` flag to skip emitting JS code from compilation.