aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorMichael Williamson <mike@zwobble.org>2016-05-25 22:56:28 +0100
committerMichael Williamson <mike@zwobble.org>2016-05-25 22:56:28 +0100
commit6902fb4b752641f953b7701d67550f2de04912e9 (patch)
tree6ecd877d92b89149d1b83b39ad9b6e58efc48510 /README.md
parent9e8bf0001082d7836b7a672373e2800f26bbece4 (diff)
Add Hello world example for Java to C#
Diffstat (limited to 'README.md')
-rw-r--r--README.md37
1 files changed, 32 insertions, 5 deletions
diff --git a/README.md b/README.md
index 59a9390..e4f4bfc 100644
--- a/README.md
+++ b/README.md
@@ -2,15 +2,30 @@
Convert Java source code to other languages. C# and Python currently supported.
-## Usage
+## Hello world: Java to C#
-1. Build the JAR:
+1. Build the JAR:
```
mvn package -Dmaven.test.skip=true
```
-2. Create a file called `couscous.json`:
+2. Create a Java source file:
+
+ ```java
+ package com.example;
+
+ public class Example {
+ public static void main() {
+ System.out.println("Hello world");
+ }
+ }
+ ```
+
+ Assuming the normal Maven layout,
+ this file should be at `src/main/java/com/example/Example.java`.
+
+3. Create a file called `couscous.json`:
```
{
@@ -21,16 +36,28 @@ Convert Java source code to other languages. C# and Python currently supported.
"files": [
"src/main/java/com/example",
],
- "output": "dotnet/Example/generated.cs",
+ "output": "dotnet/generated.cs",
"namespace": "Example"
}
```
-3. In the directory containing `couscous.json`:
+4. In the directory containing `couscous.json`:
```
java -jar path/to/couscous.jar
```
+
+ This should generate the file `dotnet/generated.cs`, which looks something like:
+
+ ```csharp
+ namespace Example.com.example {
+ internal class Example {
+ public static void main() {
+ (Example.java.lang.System._out).println("Hello world");
+ }
+ }
+ }
+ ```
## TODO