bastools/api/README.md

33 lines
805 B
Markdown
Raw Normal View History

2018-06-20 01:09:53 +00:00
# BASIC Tools API
2018-05-29 20:41:03 +00:00
2018-06-13 00:41:40 +00:00
The BASIC Tools API is a set of reusable code that can be used to parse a text-based Applesoft BASIC program an generate the appropriate tokens. It also has multiple types of visitors that can re-write that parse tree to rearrange the code (calling them optimizations is a bit over-the-top).
2018-05-29 20:41:03 +00:00
2018-05-30 02:13:35 +00:00
## Maven / Gradle
To include in a Maven project:
```xml
<dependency>
<groupId>net.sf.applecommander</groupId>
<artifactId>bastools-api</artifactId>
2019-09-03 02:12:43 +00:00
<version>0.3.1</version>
2018-05-30 02:13:35 +00:00
</dependency>
```
To include in a Gradle project:
```
dependencies {
// ...
2019-09-03 02:12:43 +00:00
compile "net.sf.applecommander:bastools-api:0.3.1"
2018-05-30 02:13:35 +00:00
// ...
}
```
2018-06-20 01:09:53 +00:00
## API descriptions
2018-05-29 20:41:03 +00:00
2018-06-20 01:09:53 +00:00
Currently the API is broken into the following sections:
2018-05-29 20:41:03 +00:00
2018-06-20 01:09:53 +00:00
* [BASIC Tokenizer](README-TOKENIZER.md)
* [Shape Tooling](README-SHAPES.md)