Skip to content

Commit

Permalink
Added a section about the project structure and files.
Browse files Browse the repository at this point in the history
  • Loading branch information
DobromirM committed Oct 10, 2023
1 parent 8c0d3b1 commit d53f3a5
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,17 @@ or download manually and run:
```
sudo tar -f swim-create-x86_64-unknown-linux-gnu.tar.gz -xz -C /usr/local/bin
```

## Project structure

The CLI tool creates a base Swim project that is runnable, allowing developers to get started quicker by just adding their business logic.

A brief description of the most important files and their function:

`settings.gradle` - Contains the project name.

`build.gradle` - Contains the name of the main Java class and the Swim version.

`server.recon` - Contains information about the Swim plane and the port for the Swim server.

`MainPlane.java` - Is the Swim plane definition and the entry point.

0 comments on commit d53f3a5

Please sign in to comment.