Skip to content

Commit c677809

Browse files
authored
Merge pull request #85 from olmps/updates-readme
Updates README (ptBR as well) with new badge and app icon
2 parents 170e49b + ad7b0fa commit c677809

File tree

5 files changed

+29
-27
lines changed

5 files changed

+29
-27
lines changed

.github/workflows/pull-request.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# Triggers on all changes committed to Pull Requests pointing to `main` branch
2-
name: Pull Request Workflow
2+
name: Pull Request
33

44
on:
55
pull_request:

.github/workflows/release.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: Release Workflow
1+
name: Release
22

33
on:
44
release:

CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ a beta or production release, they must be documented here).
1010

1111
## [Unreleased]
1212

13-
## [Unreleased] [0.1.0-rc.1]
13+
## [0.1.0-rc.1] - 2021-05-08
1414

1515
Introduces the first release candidate with all the first idealized functionalities for `memo`:
1616

README.md

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,28 @@
11
English | [Portuguese](README_ptbr.md)
22

3-
# Memo
4-
5-
<p align="center">
6-
<a href="https://github.com/olmps/memo/actions"><img src="https://github.com/olmps/memo/actions/workflows/flutter-ci.yml/badge.svg" alt="Build Status"></a>
7-
</p>
3+
<div align="center">
4+
<h1>Memo</h1>
5+
<img src="https://raw.githubusercontent.com/olmps/memo/master/assets/icon.png" alt="Memo Icon" width="200">
6+
<br>
7+
<br>
8+
<a href="https://github.com/olmps/memo/actions/workflows/release.yml">
9+
<img src="https://github.com/olmps/memo/actions/workflows/release.yml/badge.svg" alt="Release">
10+
</a>
11+
<br>
12+
<br>
13+
</div>
814

915
Monorepo for Memo.
1016

1117
Memo is an open-source, programming-oriented [spaced repetition](https://en.wikipedia.org/wiki/Spaced_repetition)
1218
software (SRS) written in Flutter.
1319

14-
<!--
15-
You can use the latest beta features through TestFlight / Google Play, or download through:
16-
17-
AppStore (badge)
18-
Google Play (badge)
19-
-->
20-
2120
> As of now, this project is designed to only output builds for Android and iOS. Even though, given the current
2221
> _stability_ of Flutter SDK for desktop (Windows, Linux and macOS) and web, there is a high probability that this
2322
> project will eventually support builds for all platforms.
2423
24+
---
25+
2526
This README is meant to guide how this project is structured and should serve as a guide to help the project scale with
2627
the current and future requirements. Think of it as a flexible set of rules that guides the project's decisions. While
2728
they can (and probably will) change over time, discussions must be raised to trigger such changes: this means that

README_ptbr.md

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,28 @@
11
[Inglês](/README.md) | Português
22

3-
# Memo
4-
5-
<p align="center">
6-
<a href="https://github.com/olmps/memo/actions"><img src="https://github.com/olmps/memo/actions/workflows/flutter-ci.yml/badge.svg" alt="Build Status"></a>
7-
</p>
3+
<div align="center">
4+
<h1>Memo</h1>
5+
<img src="https://raw.githubusercontent.com/olmps/memo/master/assets/icon.png" alt="Memo Icon" width="200">
6+
<br>
7+
<br>
8+
<a href="https://github.com/olmps/memo/actions/workflows/release.yml">
9+
<img src="https://github.com/olmps/memo/actions/workflows/release.yml/badge.svg" alt="Release">
10+
</a>
11+
<br>
12+
<br>
13+
</div>
814

915
Monorepo do Memo.
1016

1117
Memo é um software de código aberto (escrito em Flutter) de
1218
[repetição espaçada](https://en.wikipedia.org/wiki/Spaced_repetition) (SRS, em inglês) voltado ao tema de programação.
1319

14-
<!--
15-
You can use the latest beta features through TestFlight / Google Play, or download through:
16-
17-
AppStore (badge)
18-
Google Play (badge)
19-
-->
20-
2120
> Atualmente, este projeto está construído apenas para gerar _builds_ para Android e iOS. Embora o fato de que, dado a
2221
> estabilidade da SDK do Flutter para desktop (Windows, Linux e macOS) e web, existe uma alta probabilidade que este
2322
> projeto eventualmente suportará _builds_ para todas as plataformas.
2423
24+
---
25+
2526
Este README e todos os sub-documentos presentes aqui (CONTRIBUTING, ARCHITECTURE & CHANGELOG) tem como objetivo guiar a
2627
estrutura deste projeto e devem auxiliar na escalabilidade das funcionalidades existentes hoje e nas que serão criadas
2728
com o decorrer do andamento do projeto. Estes documentos servem como um conjunto flexível de regras que guiam as

0 commit comments

Comments
 (0)