diff options
| author | Michael Williamson <mike@zwobble.org> | 2016-05-25 22:41:22 +0100 |
|---|---|---|
| committer | Michael Williamson <mike@zwobble.org> | 2016-05-25 22:43:43 +0100 |
| commit | 9e8bf0001082d7836b7a672373e2800f26bbece4 (patch) | |
| tree | b3945e435faed0e7ac5a1f52adde1a791dbaa991 /README.md | |
| parent | dc5c7603640767bdecde81801f6478c7604b550d (diff) | |
Add brief notes on usage
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 34 |
1 files changed, 34 insertions, 0 deletions
@@ -1,3 +1,37 @@ +# Couscous + +Convert Java source code to other languages. C# and Python currently supported. + +## Usage + +1. Build the JAR: + + ``` + mvn package -Dmaven.test.skip=true + ``` + +2. Create a file called `couscous.json`: + + ``` + { + "backend": "csharp", + "sourcepath": [ + "src/main/java" + ], + "files": [ + "src/main/java/com/example", + ], + "output": "dotnet/Example/generated.cs", + "namespace": "Example" + } + ``` + +3. In the directory containing `couscous.json`: + + ``` + java -jar path/to/couscous.jar + ``` + ## TODO * Multiple constructors |
