Skip to content

Commit 601ae28

Browse files
committed
feat: Add readme first sections.
1 parent 618eeba commit 601ae28

File tree

1 file changed

+90
-2
lines changed

1 file changed

+90
-2
lines changed

README.md

+90-2
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,90 @@
1-
# flutter-wysiwyg-editor-tutorial
2-
📱📝 How to do WYSIWYG editing in Flutter in 5 easy steps. 🚀
1+
<div align="center">
2+
3+
# `Flutter` `WYSIWYG` editor tutorial
4+
5+
📱 📝 How to do WYSIWYG editing in Flutter in a few easy steps.
6+
7+
![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/dwyl/flutter-wysiwyg-editor-tutorial/ci.yml?label=build&style=flat-square&branch=main)
8+
[![codecov.io](https://img.shields.io/codecov/c/github/dwyl/flutter-wysiwyg-editor-tutorial/master.svg?style=flat-square)](https://codecov.io/github/dwyl/flutter-wysiwyg-editor-tutorial?branch=master)
9+
[![HitCount](https://hits.dwyl.com/dwyl/flutter-wysiwyg-editor-tutorial.svg?style=flat-square&show=unique)](https://hits.dwyl.com/dwyl/flutter-wysiwyg-editor-tutorial)
10+
[![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat-square)](https://github.com/dwyl/flutter-wysiwyg-editor-tutorial/issues)
11+
12+
13+
</div>
14+
<br />
15+
16+
- [`Flutter` `WYSIWYG` editor tutorial](#flutter-wysiwyg-editor-tutorial)
17+
- [Why? 🤷‍](#why-)
18+
- [What? 💭](#what-)
19+
- [Who? 👤](#who-)
20+
- [_How_? 👩‍💻](#how-)
21+
- [Prerequisites? 📝](#prerequisites-)
22+
- [0. Project setup](#0-project-setup)
23+
24+
25+
# Why? 🤷‍
26+
27+
On our [`app`](https://github.com/dwyl/app),
28+
people will add their todo items.
29+
To do so, they *need* a capable editor
30+
that is easy-to-use that also supports
31+
customization
32+
(new buttons).
33+
34+
# What? 💭
35+
36+
When typing text,
37+
the person using should be able to edit/format it
38+
to their heart's content
39+
and customize it to their liking.
40+
41+
This repo will showcase an introduction
42+
of a `WYSIWYG` Rich Text editor
43+
that can be used on both mobile and web devices.
44+
We want this editor to be *extensible*,
45+
meaning that we want to add specific features
46+
and *introduce them* to the person
47+
incrementally.
48+
49+
50+
# Who? 👤
51+
52+
This quick demo is aimed at people in the @dwyl team
53+
or anyone who is interested in learning
54+
more about building a `WYSIWYG` editor.
55+
56+
# _How_? 👩‍💻
57+
58+
## Prerequisites? 📝
59+
60+
This demo assumes you have foundational knowledge of `Flutter`.
61+
If this is your first time tinkering with `Flutter`,
62+
we suggest you first take a look at
63+
https://github.com/dwyl/learn-flutter.
64+
65+
In the linked repo, you will learn
66+
how to install the needed dependencies
67+
and how to debug your app on both an emulator
68+
or a physical device.
69+
70+
71+
## 0. Project setup
72+
73+
To create a new project in `Flutter`,
74+
follow the steps in
75+
https://github.com/dwyl/learn-flutter#0-setting-up-a-new-project.
76+
77+
After completing these steps,
78+
you should have a boilerplate `Flutter` project.
79+
80+
If you run the app, you should see the template Counter app.
81+
The tests should also run correctly.
82+
Executing `flutter test --coverage` should yield
83+
this output on the terminal.
84+
85+
```sh
86+
00:02 +1: All tests passed!
87+
```
88+
89+
This means everything is correctly set up!
90+
We are ready to start implementing!

0 commit comments

Comments
 (0)