This is an automated email from the ASF dual-hosted git repository.
asf-gitbox-commits pushed a commit to branch 2.1.X
in repository https://gitbox.apache.org/repos/asf/mina.git
The following commit(s) were added to refs/heads/2.1.X by this push:
new b299ec0fc Added the README file
b299ec0fc is described below
commit b299ec0fc642acb168705712ff92402e42658577
Author: Emmanuel Lécharny <[email protected]>
AuthorDate: Mon Jun 1 17:46:10 2026 +0200
Added the README file
---
README.md | 71 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
1 file changed, 71 insertions(+)
diff --git a/README.md b/README.md
new file mode 100644
index 000000000..675f8540d
--- /dev/null
+++ b/README.md
@@ -0,0 +1,71 @@
+[//]: # "/*"
+[//]: # " * Licensed to the Apache Software Foundation (ASF) under one"
+[//]: # " * or more contributor license agreements. See the NOTICE file"
+[//]: # " * distributed with this work for additional information"
+[//]: # " * regarding copyright ownership. The ASF licenses this file"
+[//]: # " * to you under the Apache License, Version 2.0 (the"
+[//]: # " * \"License\"); you may not use this file except in compliance"
+[//]: # " * with the License. You may obtain a copy of the License at"
+[//]: # " *"
+[//]: # " * https://www.apache.org/licenses/LICENSE-2.0";
+[//]: # " *"
+[//]: # " * Unless required by applicable law or agreed to in writing,"
+[//]: # " * software distributed under the License is distributed on an"
+[//]: # " * \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY"
+[//]: # " * KIND, either express or implied. See the License for the"
+[//]: # " * specific language governing permissions and limitations"
+[//]: # " * under the License."
+[//]: # " */"
+# Apache MINA developer guide
+
+This document gathers the minimal information about how to build the project.
+
+All the detailed information can be found in the (MINA Developer Guide
page)[https://mina.apache.org/mina-project/developer-g
+uide.html]
+
+## Building MINA
+
+You need Git to check out the source code from our source code repository.
+
+We have 3 branches:
+
+* 2.2.X, The latest version
+* 2.1.X
+* 2.0.X
+
+NOTE: The trunk is a dead branch!
+
+The following example shows how to get the current stable branch (2.2.X).
+
+```
+$ git clone -b 2.2.X https://gitbox.apache.org/repos/asf/mina.git mina-2.2.X
+$ cd mina-2.2.X
+```
+
+## Prerequisites
+
+MINA requires Maven 3.8.5 at least, but builds well with recent version (we
haven't yet tested it with Maven 4)
+
+You will need different versions of Java for the three branches:
+
+* 2.2.X: Java 17 is required
+* 2.1.X and 2.0.X: Java 1.8 is required
+
+## Building MINA
+
+It's as simple as typing:
+
+```
+$ mvn clean install [-Pserial]
+```
+
+(The '-Pserial' flag is optional. It's onlt use if you want to generate the
code using the LGPL rxtx library).
+
+You are done...
+
+## Code convention
+
+Like it or not, we follow the ancient Sun's standard Java convention. Not
tabs, 4 spaces instead. Please respect this convezn
+tion, it saves the committers a lot of time when merging PRs.
+
+
