Skip to content

Commit

Permalink
Merge pull request #85 from olmps/updates-readme
Browse files Browse the repository at this point in the history
Updates README (ptBR as well) with new badge and app icon
  • Loading branch information
matuella authored May 8, 2021
2 parents 170e49b + ad7b0fa commit c677809
Show file tree
Hide file tree
Showing 5 changed files with 29 additions and 27 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/pull-request.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Triggers on all changes committed to Pull Requests pointing to `main` branch
name: Pull Request Workflow
name: Pull Request

on:
pull_request:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/release.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: Release Workflow
name: Release

on:
release:
Expand Down
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ a beta or production release, they must be documented here).

## [Unreleased]

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

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

Expand Down
25 changes: 13 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,28 @@
English | [Portuguese](README_ptbr.md)

# Memo

<p align="center">
<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>
</p>
<div align="center">
<h1>Memo</h1>
<img src="https://raw.githubusercontent.com/olmps/memo/master/assets/icon.png" alt="Memo Icon" width="200">
<br>
<br>
<a href="https://github.com/olmps/memo/actions/workflows/release.yml">
<img src="https://github.com/olmps/memo/actions/workflows/release.yml/badge.svg" alt="Release">
</a>
<br>
<br>
</div>

Monorepo for Memo.

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

<!--
You can use the latest beta features through TestFlight / Google Play, or download through:
AppStore (badge)
Google Play (badge)
-->

> As of now, this project is designed to only output builds for Android and iOS. Even though, given the current
> _stability_ of Flutter SDK for desktop (Windows, Linux and macOS) and web, there is a high probability that this
> project will eventually support builds for all platforms.
---

This README is meant to guide how this project is structured and should serve as a guide to help the project scale with
the current and future requirements. Think of it as a flexible set of rules that guides the project's decisions. While
they can (and probably will) change over time, discussions must be raised to trigger such changes: this means that
Expand Down
25 changes: 13 additions & 12 deletions README_ptbr.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,28 @@
[Inglês](/README.md) | Português

# Memo

<p align="center">
<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>
</p>
<div align="center">
<h1>Memo</h1>
<img src="https://raw.githubusercontent.com/olmps/memo/master/assets/icon.png" alt="Memo Icon" width="200">
<br>
<br>
<a href="https://github.com/olmps/memo/actions/workflows/release.yml">
<img src="https://github.com/olmps/memo/actions/workflows/release.yml/badge.svg" alt="Release">
</a>
<br>
<br>
</div>

Monorepo do Memo.

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

<!--
You can use the latest beta features through TestFlight / Google Play, or download through:
AppStore (badge)
Google Play (badge)
-->

> Atualmente, este projeto está construído apenas para gerar _builds_ para Android e iOS. Embora o fato de que, dado a
> estabilidade da SDK do Flutter para desktop (Windows, Linux e macOS) e web, existe uma alta probabilidade que este
> projeto eventualmente suportará _builds_ para todas as plataformas.
---

Este README e todos os sub-documentos presentes aqui (CONTRIBUTING, ARCHITECTURE & CHANGELOG) tem como objetivo guiar a
estrutura deste projeto e devem auxiliar na escalabilidade das funcionalidades existentes hoje e nas que serão criadas
com o decorrer do andamento do projeto. Estes documentos servem como um conjunto flexível de regras que guiam as
Expand Down

0 comments on commit c677809

Please sign in to comment.