Skip to content

Add feature details in README #88

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.

Sign up for GitHub

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

Draft
kjw142857 wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Add feature details in README #88

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
22 changes: 22 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ Open-source Implementation of the Java language in TypeScript. (<https://docs.or
- [Table of Contents](#table-of-contents)
- [Prerequisites](#prerequisites)
- [Usage](#usage)
- [Current Features](#current-features)
- [Future Features](#future-features)
- [Testing](#testing)
- [Using your java-slang in Source Academy](#using-your-java-slang-in-source-academy)
- [Using your java-slang in your local Source Academy](#using-your-java-slang-in-your-local-source-academy)
Expand Down Expand Up @@ -39,6 +41,26 @@ $ git submodule update --init --recursive
$ git submodule update --recursive --remote
```

## Current Features

The Java language in Source Academy currently supports a host of available features, including:

- Primitive classes: boolean, byte, short, int, long, char, float and double.
- Custom (non-primitive) classes
- Method overloading
- Implicit type widening for both primitive and non-primitive types (e.g. int to long)
- Basic exception/error messages
- Basic system calls e.g. System.out.println
- Single nested class

## Future Features

- Multiple class declarations in the same file
- Inheritance (basis for implementation exists but requires multiclass declaration to function)
- Explicit type conversion (type narrowing)
- Implicit type conversion for system calls (e.g. int input to System.out.println)
- Generics
- Multi-file programs

## Testing

Expand Down