Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update read me #21

Merged
merged 8 commits into from
Jun 15, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 36 additions & 9 deletions README.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,20 +7,19 @@
Abitur grades calculator for iOs 14 or higher.
Read this in other languages: [Deutsch](https://github.com/AKORA-Studios/Calq/blob/master/README.md)

([latest Release download](https://github.com/AKORA-Studios/Calq/releases/))

### [Appstore Link](https://apps.apple.com/tt/app/calq-abiturnoten/id1605925893?uo=2)

<br>

## Features

- Calculate high school graduation average
- Calculate subject average
- Export data as JSON (note: does not include final exams)
- Export data as JSON
- (optional) Automatic subject colors
- Calculate impact of new grade
- Disable half-years
- multiple gradetypes with variable weight
- Languages: 🇩🇪 🇺🇸

[<img src="resources/appstoreImage_en.svg" height="50">](https://apps.apple.com/tt/app/calq-abiturnoten/id1605925893?uo=2)
<br>

## Showcase

Expand All @@ -44,7 +43,7 @@ Read this in other languages: [Deutsch](https://github.com/AKORA-Studios/Calq/bl

</details>

<details open>
<details closed>
<summary>Showcase Widget</summary>
<br>

Expand All @@ -54,9 +53,37 @@ Read this in other languages: [Deutsch](https://github.com/AKORA-Studios/Calq/bl
</details
<br>

## Contributors

<a href = "https://github.com/AKORA-Studios/Calq/graphs/contributors">
<img src = "https://contrib.rocks/image?repo=AKORA-Studios/Calq"/>
</a>

## How to Install and Run the Project

```
git clone https://github.com/AKORA-Studios/Calq
```

- Open the workspace file in Xcode
- Use **CMD + R** to run the app sheme

(note: yes there is a podfile in this repo, but there arent any used currently)

## Requirements

- iOS 14.1+
- Xcode Xcode 12.1

## How to contribute

If you encounter any issues or have improvment suggestions open a ticket

Or if you want to change smth yourself or have any suggestions how to solve an open issue, fork the repository (master), create a new branch describing your change/issue, then create a mergerequest explaining what you changed. Pls name your commits somewhere usefull. If you have a lot of commits pls squash them in the mergerequest.

## Feature Requests

[Future features](https://github.com/AKORA-Studios/Calq/projects/2) are listed in our repos projects. you have a feature request? For this you can open issue [right here](https://github.com/AKORA-Studios/Calq/issues).
[Future features](https://github.com/AKORA-Studios/Calq/projects/2) are listed in our repos projects. you have a feature request? For this you can open issue [right here](https://github.com/AKORA-Studios/Calq/issues). Or you can message us via discord.

# License

Expand Down
41 changes: 34 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,6 @@
Abiturnoten Rchner für iOs 14 oder höher.
ReadMe in anderen Sprachen: [Englisch](https://github.com/AKORA-Studios/Calq/blob/master/README.en.md).

([latest Release download](https://github.com/AKORA-Studios/Calq/releases/))

### [Appstore Link](https://apps.apple.com/tt/app/calq-abiturnoten/id1605925893?uo=2)

<br>

## Funktionen

- Abiturschnitt berechnen
Expand All @@ -23,6 +17,10 @@ ReadMe in anderen Sprachen: [Englisch](https://github.com/AKORA-Studios/Calq/blo
- Berechnung Auswirkung neuer Note
- Deaktivieren von Halbjahren
- mehrere Notentypen mit variabler Gewichtung
- Sprachen: 🇩🇪 🇺🇸

[<img src="resources/appstoreImage.svg" height="50">](https://apps.apple.com/tt/app/calq-abiturnoten/id1605925893?uo=2)
<br>

## Showcase

Expand All @@ -46,7 +44,7 @@ ReadMe in anderen Sprachen: [Englisch](https://github.com/AKORA-Studios/Calq/blo

</details>

<details open>
<details closed>
<summary>Showcase Widget</summary>
<br>

Expand All @@ -55,9 +53,38 @@ ReadMe in anderen Sprachen: [Englisch](https://github.com/AKORA-Studios/Calq/blo
</details
<br>

## Contributors

<a href = "https://github.com/AKORA-Studios/Calq/graphs/contributors">
<img src = "https://contrib.rocks/image?repo=AKORA-Studios/Calq"/>
</a>

## How to Install and Run the Project

```
git clone https://github.com/AKORA-Studios/Calq
```

- Open the workspace file in Xcode
- Use **CMD + R** to run the app sheme

(note: yes there is a podfile in this repo, but there arent any used currently)

## Requirements

- iOS 14.1+
- Xcode Xcode 12.1

## How to contribute

If you encounter any issues or have improvment suggestions open a ticket

Or if you want to change smth yourself or have any suggestions how to solve an open issue, fork the repository (master), create a new branch describing your change/issue, then create a mergerequest explaining what you changed. Pls name your commits somewhere usefull. If you have a lot of commits pls squash them in the mergerequest.

## Feature Requests

[Future features](https://github.com/AKORA-Studios/Calq/projects2) sind in dem Reiter Projekte aufgelistet. Du hast einen weiteren Verbesserungsvorschlag? [Hier](https://github.com/AKORA-Studios/Calq/issues) kannst du eines vorschlagen.
Alternativ schreib einfach eine Nachricht aufm Discord ;3

# License

Expand Down
40 changes: 40 additions & 0 deletions Resources/appstoreImage.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading