Skip to content

Commit 95aec61

Browse files
author
Alex Davies-Moore
committed
Moved all docs to plain markdown
1 parent aac2048 commit 95aec61

File tree

9 files changed

+402
-9
lines changed

9 files changed

+402
-9
lines changed

README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -109,4 +109,10 @@ by tests:
109109
}
110110

111111
Plugin plugin = new Plugin(request);
112-
plugin.process();
112+
plugin.process();
113+
114+
# Guides
115+
116+
| Platform | Document |
117+
|:----------|:--------------------------------------|
118+
| Undertow | (undertow.md)[docs/undertow.md] |

docs/_config.yml

Lines changed: 0 additions & 1 deletion
This file was deleted.

docs/build.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# Building & Installation
2+
3+
## Requirements
4+
5+
The build has been tested with [Oracle's JDK](http://www.oracle.com/technetwork/java/javase/downloads/index.html "JDK Downloads") (version 1.8)
6+
7+
The build uses gradle to generate the artifacts. No installation is required as the project uses the
8+
[gradle wrapper](https://docs.gradle.org/current/userguide/gradle_wrapper.html "gradle wrapper") setup.
9+
10+
For testing you will need an installation of the [protocol buffers compiler](https://github.com/google/protobuf/releases "protobuf releases").
11+
12+
## Modules
13+
14+
The project is split into the following modules:
15+
16+
| Module | Description |
17+
|:------------------|:------------------------------------------------------|
18+
| `plugin` | The `protoc` plugin |
19+
| `runtime:core` | Core functionality required by generated code |
20+
| `runtime:spring` | Runtime library for Spring MVC/Boot servers |
21+
| `runtime:undertow`| Runtime library for Undertow servers |
22+
23+
24+
## Build
25+
26+
To build the various components, run the following:
27+
28+
git clone git@github.com:devork/flit.git
29+
cd flit
30+
./gradlew clean build pack
31+
32+
## Installation
33+
34+
Currently, the run script only supports *nix but the run script should be fairly easy to migrate to windows.
35+
36+
After building:
37+
38+
cp plugin/build/package/flit-plugin.zip /usr/local/bin
39+
cd /usr/local/bin
40+
unzip flit-plugin.zip
41+
chmod +x protoc-gen-flit

docs/index.md

Lines changed: 0 additions & 4 deletions
This file was deleted.

docs/spring.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# Spring Server Generation
2+

0 commit comments

Comments
 (0)