Skip to content

Commit

Permalink
Merge remote-tracking branch 'origin/main'
Browse files Browse the repository at this point in the history
  • Loading branch information
darmiel committed Mar 1, 2022
2 parents b1188c1 + e668de1 commit 3fdf487
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 12 deletions.
7 changes: 3 additions & 4 deletions docs/entrypoint.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
![prev](assets/action.gif)

The framework makes it very easy to define multiple "entry points"
(annotated with `@Entrypoint`) without always having to write different main methods:
(annotated with `@Entrypoint`) without having to write different main methods:

```java
public class Application {
Expand All @@ -21,9 +21,8 @@ public class Application {

}
```

If you now start the program, invoking `Starter.start` in your main method, you will be asked which
program you want to run:
You will be asked which program you want to run if you start the program and invoke Starter.start
in your main method.

```java
public static void main(String[] args) throws Exception {
Expand Down
7 changes: 3 additions & 4 deletions docs/generate.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@

![prev](assets/generator-action.gif)

Sample objects can be created with the help of the `RandomFactory`. To do this, any constructor in
the target class must be annotated with `@Generate`.
Sample objects can be created with the help of the `RandomFactory`. Any constructor in
the target class must be annotated with `@Generate` in order to work correctly.

**NOTE:** make sure all parameters can be generated.

Expand Down Expand Up @@ -56,9 +56,8 @@ class Person {

}
```

You can implement your own generators by implementing the Generator<T>
interface in the class to be generated.
interface in the class that is to be generated.

```java
public class A implements Generator<A> {
Expand Down
8 changes: 4 additions & 4 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# EEEE

EEEE* is a tiny framework for simple console input of values and generation of objects, which I
wrote mainly for exercises of the university, because here often simple inputs with a scanner are
needed, and I did not want to rewrite them again and again.
wrote mainly for exercises of my university, because often simple inputs with a scanner are
needed, and I did not want to rewrite them all the time.

Also, I didn't use any existing frameworks, ~~because apparently we are only allowed to use
self-written code in the exams, and so I am allowed to use this mini-framework in the exams~~.
self-written code in the exams, and thus I am allowed to use this mini-framework in the exams~~.

**EDIT:** Looks like all frameworks are allowed. Well shit.

Expand All @@ -14,7 +14,7 @@ self-written code in the exams, and so I am allowed to use this mini-framework i
**NOTE:** This framework is ab-so-lutely not suitable for production use. It should only serve for
practice. Also, definitely not type-safe.

Below, you can find some quick starts for each module.
[Here](https://github.com/darmiel/eeee/tree/main/src/main/java/example), you can find some examples for some modules.

---

Expand Down

0 comments on commit 3fdf487

Please sign in to comment.