Skip to content

Commit

Permalink
Merge pull request #82 from P4-ACMMMRW/readme
Browse files Browse the repository at this point in the history
Update README.md
  • Loading branch information
MegaScooper authored May 28, 2024
2 parents 3c7de49 + f494d97 commit cbc9b83
Showing 1 changed file with 23 additions and 13 deletions.
36 changes: 23 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,26 +2,36 @@
[![Linting](https://github.com/P4-ACMMMRW/dpli/actions/workflows/linting.yml/badge.svg?branch=main)](https://github.com/P4-ACMMMRW/dpli/actions/workflows/linting.yml)

# DPL Interpreter
The official interpreter for Data Preprocessing Language (DPL).
The official interpreter for Data Preprocessing Language (DPL). DPL is a domain-specific language for preprocessing of tabular data. DPL has a built-in `table` type to represent tabular data and has unique syntax for filtering data along with special `union` and `intersection` operators. The syntax of DPL is similar to Python since this is a language that is already popular within this domain.

## Documentation
Language documentation and program examples can be found under the `docs/` folder.

## Future Plans
- [ ] Modules
- [ ] Compound Operators
- [ ] More Str, List, Column, and Table Operations
- [ ] Dictionaries
- [ ] Smarter readTable
- [ ] Better Error Messages

## Precompiled Binaries
Precompiled binaries can be found under the actions tab on github.

## How to Compile
### Dependencies
- `Java JDK 11+`
- `cmake`
- `c++17 compiler`

On Ubuntu simply run:
```bash
./scripts/compile.sh
```

On other linux distrobutions:
```bash
On other platforms:
```
mkdir build
cd build
cmake ..; make
cmake ..; cmake --build .
```

### Dependencies
- `Java JDK 11+`
- `cmake`
- `c++17 compiler`

## Future Plans

## Documentation

0 comments on commit cbc9b83

Please sign in to comment.