Skip to content

Commit

Permalink
📝 Update Getting Started Information
Browse files Browse the repository at this point in the history
  • Loading branch information
gilday committed Jan 26, 2023
1 parent 8385d9a commit 4da69fc
Showing 1 changed file with 25 additions and 7 deletions.
32 changes: 25 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,18 +3,38 @@
CLI tool for leveraging the Code Transformation Language (CodeTL) to apply complex source code
transformations to projects.

## Building
## Developing

Follow these instructions if you intend to modify and build this project from
source.

### First Time Set Up

1. Install GraalVM 22.3.0
2. Install native-image component
```shell
gu install native-image
```
3. Build CLI tool
```shell
./gradlew assemble
3. Initialize Submodules

```shell
git submodule init
git submodule update
```

4. Configure JFrog Artifactory Authentication by adding the following properties to your Gradle home gradle.properties (typically `$HOME/.gradle/gradle.properties`):
```
pixeeArtifactoryUsername=<your-username>
pixeeArtifactoryPassword=<your-token>
```
4. The built binary is at path `./cli/build/native/nativeCompile/codetl`

### Building

```shell
./gradlew assemble
```

The built binary is at path `./cli/build/native/nativeCompile/codetl`

### Running Tests

Expand All @@ -27,8 +47,6 @@ transformations to projects.
CodeTL is a language agnostic tool and code transformation domain specific language (DSL). Support
for a language is added by an extension called a "language provider". These language providers may be found in the `./languages` directory.



### ⚗️ JavaScript Language Provider Proof of Concept

In the working architecture, language providers are written in the language they support. For
Expand Down

0 comments on commit 4da69fc

Please sign in to comment.