Skip to content

Commit 62d9d29

Browse files
MacroControllerMacroController
andauthored
[Fix] Markdown linter problems (#2084)
* MD024 * MD033 * MD034 * MD036 * MD040 * MD045 * MD046 --------- Co-authored-by: MacroController <[email protected]>
1 parent 451b536 commit 62d9d29

File tree

3 files changed

+36
-47
lines changed

3 files changed

+36
-47
lines changed

NOTICE.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Copyright Notices
22

3-
### ActiveAndroid
3+
## ActiveAndroid
44

55
<https://github.com/pardom/ActiveAndroid>
66

@@ -18,7 +18,7 @@
1818
See the License for the specific language governing permissions and
1919
limitations under the License.
2020

21-
### Android Open Source Project
21+
## Android Open Source Project
2222

2323
<https://source.android.com/>
2424

@@ -36,7 +36,7 @@
3636
See the License for the specific language governing permissions and
3737
limitations under the License.
3838

39-
### FontAwesome
39+
## FontAwesome
4040

4141
<http://fontawesome.io>
4242

@@ -59,15 +59,15 @@ under the SIL OFL 1.1.
5959
requirement for fonts to remain under this license does not apply
6060
to any document created using the fonts or their derivatives.
6161

62-
### Material Design Icons
62+
## Material Design Icons
6363

6464
<https://github.com/google/material-design-icons>
6565

6666
Material design icons are the official icon set from Google that are designed
6767
under the material design guidelines. Available under the Creative Common
6868
Attribution 4.0 International License (CC-BY 4.0).
6969

70-
### Android Flow Layout
70+
## Android Flow Layout
7171

7272
<https://github.com/ApmeM/android-flowlayout>
7373

@@ -87,7 +87,7 @@ Extended linear layout that wrap its content when there is no place in the curre
8787
License for the specific language governing permissions and limitations
8888
under the License.
8989

90-
### Dagger 2
90+
## Dagger 2
9191

9292
<https://github.com/google/dagger>
9393

@@ -108,7 +108,7 @@ A fast dependency injector for Android and Java.
108108
See the License for the specific language governing permissions and
109109
limitations under the License.
110110

111-
### AutoFactory
111+
## AutoFactory
112112

113113
<https://github.com/google/auto/tree/master/factory>
114114

@@ -128,7 +128,7 @@ A source code generator for JSR-330-compatible factories.
128128
See the License for the specific language governing permissions and
129129
limitations under the License.
130130

131-
### Retrolambda
131+
## Retrolambda
132132

133133
<https://github.com/orfjackal/retrolambda>
134134

@@ -138,7 +138,7 @@ Backport of Java 8's lambda expressions to Java 7, 6 and 5
138138
This software is released under the Apache License 2.0.
139139
The license text is at http://www.apache.org/licenses/LICENSE-2.0
140140

141-
### PebbleKit SDK
141+
## PebbleKit SDK
142142

143143
<https://github.com/pebble/pebble-android-sdk/>
144144

@@ -147,7 +147,7 @@ Android PebbleKit SDK to talk to the Pebble via Bluetooth
147147
The MIT License (MIT)
148148
Copyright (c) 2014 - 2015 Pebble Technology
149149

150-
### AppIntro
150+
## AppIntro
151151

152152
<https://github.com/PaoloRotolo/AppIntro>
153153

@@ -168,7 +168,7 @@ Make a cool intro for your Android app.
168168
See the License for the specific language governing permissions and
169169
limitations under the License.
170170

171-
### ButterKnife
171+
## ButterKnife
172172

173173
<https://github.com/JakeWharton/butterknife>
174174

@@ -188,7 +188,7 @@ Bind Android views and callbacks to fields and methods
188188
See the License for the specific language governing permissions and
189189
limitations under the License.
190190

191-
### opencsv
191+
## opencsv
192192

193193
<http://opencsv.sourceforge.net/>
194194

README.md

Lines changed: 13 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
<h1 align="center">Loop Habit Tracker</h1>
22
<p align="center">
33
<a href="https://github.com/iSoron/uhabits/actions?query=workflow%3A%22Build+%26+Test%22">
4-
<img src="https://github.com/iSoron/uhabits/workflows/Build%20&%20Test/badge.svg" />
4+
<img alt="Build & Test" src="https://github.com/iSoron/uhabits/workflows/Build%20&%20Test/badge.svg" />
55
</a>
66
<a href="https://github.com/iSoron/uhabits/releases/latest">
7-
<img src="https://img.shields.io/github/v/release/iSoron/uhabits" />
7+
<img alt="release" src="https://img.shields.io/github/v/release/iSoron/uhabits" />
88
</a>
99
<a href="https://github.com/iSoron/uhabits/discussions">
10-
<img src="https://img.shields.io/badge/GitHub-Discussions-%23fc4ebc" />
10+
<img alt="GitHub" src="https://img.shields.io/badge/GitHub-Discussions-%23fc4ebc" />
1111
</a>
1212
</p>
1313

@@ -32,32 +32,23 @@ source.
3232

3333
## Features
3434

35-
* <b>Beautiful, minimalistic and lightweight interface.</b>
36-
Loop has an elegant and minimalistic interface that is very easy to use, even for first-time users. Highly optimized for speed, the app works well even on older phones.
35+
* **Beautiful, minimalistic and lightweight interface.** Loop has an elegant and minimalistic interface that is very easy to use, even for first-time users. Highly optimized for speed, the app works well even on older phones.
3736

38-
* <b>Habit score.</b>
39-
Loop has an advanced formula for calculating the strength of your habits. Every repetition makes your habit stronger and every missed day makes it weaker. A few missed days after a long streak, however, will not completely destroy your progress, unlike many other don't-break-the-chain apps.
37+
* **Habit score.** Loop has an advanced formula for calculating the strength of your habits. Every repetition makes your habit stronger and every missed day makes it weaker. A few missed days after a long streak, however, will not completely destroy your progress, unlike many other don't-break-the-chain apps.
4038

41-
* <b>Flexible schedules.</b>
42-
In addition to daily habits, Loop supports habits with more complex schedules, such as 3 times per week or every other day.
39+
* **Flexible schedules.** In addition to daily habits, Loop supports habits with more complex schedules, such as 3 times per week or every other day.
4340

44-
* <b>Reminders.</b>
45-
Schedule notifications to remind you of your habits. Each habit can have its own reminder, at a chosen time of the day. Easily check or dismiss your habit directly from the notification.
41+
* **Reminders.** Schedule notifications to remind you of your habits. Each habit can have its own reminder, at a chosen time of the day. Easily check or dismiss your habit directly from the notification.
4642

47-
* <b>Widgets.</b>
48-
Be reminded of your habits whenever you unlock your phone. Colorful widgets allow you to track your habits directly from your home screen, without even opening the app.
43+
* **Widgets.** Be reminded of your habits whenever you unlock your phone. Colorful widgets allow you to track your habits directly from your home screen, without even opening the app.
4944

50-
* <b>Take control of your data.</b>
51-
If you want to further analyze your data, or move it to another service, Loop allows you to export it to spreadsheets (CSV) or to a database file (SQLite). For power users, checkmarks can be added through other apps, such as Tasker.
45+
* **Take control of your data.** If you want to further analyze your data, or move it to another service, Loop allows you to export it to spreadsheets (CSV) or to a database file (SQLite). For power users, checkmarks can be added through other apps, such as Tasker.
5246

53-
* <b>No limitations.</b>
54-
Track as many habits as you wish. Loop imposes no artificial limits on how many habits you can have. All features are available to all users. There are no in-app purchases.
47+
* **No limitations.** Track as many habits as you wish. Loop imposes no artificial limits on how many habits you can have. All features are available to all users. There are no in-app purchases.
5548

56-
* <b>Completely ad-free and open source.</b>
57-
There are no advertisements, annoying notifications or intrusive permissions in this app, and there will never be. The app is completely open-source (GPLv3).
49+
* **Completely ad-free and open source.** There are no advertisements, annoying notifications or intrusive permissions in this app, and there will never be. The app is completely open-source (GPLv3).
5850

59-
* <b>Works offline and respects your privacy.</b>
60-
Loop doesn't require an Internet connection or online account registration. Your confidential data is never sent to anyone. Neither the developers nor any third-parties have access to it.
51+
* **Works offline and respects your privacy.** Loop doesn't require an Internet connection or online account registration. Your confidential data is never sent to anyone. Neither the developers nor any third-parties have access to it.
6152

6253
## Installing
6354

@@ -94,7 +85,7 @@ contribute, even if you are not a software developer.
9485

9586
## License
9687

97-
<img align="right" src="https://www.gnu.org/graphics/gplv3-88x31.png">
88+
<img align="right" alt="GPL v3" src="https://www.gnu.org/graphics/gplv3-88x31.png">
9889

9990
Copyright (C) 2016-2021 Álinson Santos Xavier <[email protected]>
10091

docs/BUILD.md

Lines changed: 11 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -9,25 +9,25 @@ This pages describes how to download and build the app from the source code. If
99

1010
## Build using Android Studio
1111

12-
**Step 1: Install git**
12+
### Step 1: Install git
1313

1414
The package `git` is required for downloading the source code of the app and submitting changes GitHub. Please see [the git book](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) for further instructions. If you are planning to submit pull requests in the future, it is recommended to [generate and configure your SSH keys](https://help.github.com/en/github/authenticating-to-github/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent).
1515

16-
**Step 2: Download and install Android Studio**
16+
### Step 2: Download and install Android Studio
1717

1818
Although Android Studio can be downloaded [from their official website](https://developer.android.com/studio/), a much better option is to install it through [JetBrains Toolbox](https://www.jetbrains.com/toolbox-app/). This tool, developed by the same developers of Android Studio, allows you to easily upgrade and downgrade the IDE, or switch between stable, beta and canary versions. After downloading and installing JetBrains Toolbox, simply click the install button near Android Studio to install the newest stable version of IDE. Beta and canary versions have not been tested and may not work correctly.
1919

2020
After installation, launch Android Studio. If this is the first time you launch it, you will need to go through a wizard to setup the IDE. The default options should work fine. The wizard will download all additional components necessary for development, including the emulator, so it may take a while.
2121

22-
**Step 3: Download the source code**
22+
### Step 3: Download the source code
2323

2424
To create a complete copy of the source code repository, open the terminal (Linux/macOS) or Git Bash (Windows), navigate to the desired folder, then run:
2525
```bash
2626
git clone https://github.com/iSoron/uhabits.git
2727
```
2828
The repository will be downloaded to the directory `uhabits`.
2929

30-
**Step 4: Open and run the project on Android Studio**
30+
### Step 4: Open and run the project on Android Studio
3131

3232
1. Launch Android Studio and select "Open an existing Android Studio project".
3333
2. When the IDE asks you for the project location, select `uhabits` and click "Ok".
@@ -41,7 +41,7 @@ The repository will be downloaded to the directory `uhabits`.
4141

4242
The following instructions were tested on **Ubuntu Linux 18.04 LTS** and may need to be modified for other operating systems.
4343

44-
**Step 1: Install basic packages**
44+
### Step 1: Install basic packages
4545

4646
To build the application, some basic packages are required. The package `git` is required to download the source code, while `openjdk-8-jdk-headless` is required for compiling Java and Kotlin files.
4747

@@ -53,14 +53,14 @@ sudo apt-get install -y git openjdk-8-jdk-headless
5353
**IMPORTANT:** Newer JDK versions have not been tested and may not work correctly.
5454

5555

56-
**Step 2: Install Android SDK tools**
56+
### Step 2: Install Android SDK tools
5757

5858
The Android SDK tools contains many necessary tools for developing and debugging Android applications. It can be obtained as part of Android Studio, but, for simple command line usage, it can also be downloaded individually.
5959

60-
1. Download the file `sdk-tools-linux-4333796.zip` (or a newer version) from https://developer.android.com/studio/#downloads, and extract it somewhere. In this guide, we assume that it was extracted to `/opt/android-sdk/tools`; that is, the script `/opt/android-sdk/tools/bin/sdkmanager` should exist.
60+
1. Download the file `sdk-tools-linux-4333796.zip` (or a newer version) from <https://developer.android.com/studio/#downloads>, and extract it somewhere. In this guide, we assume that it was extracted to `/opt/android-sdk/tools`; that is, the script `/opt/android-sdk/tools/bin/sdkmanager` should exist.
6161

6262
2. Append the following lines to `~/.profile`, so that other tools can locate your Android SDK installation. It is necessary to restart your terminal for these changes to take effect.
63-
```
63+
```bash
6464
export PATH="$PATH:/opt/android-sdk/tools/bin"
6565
export PATH="$PATH:/opt/android-sdk/platform-tools"
6666
export ANDROID_HOME="/opt/android-sdk"
@@ -71,21 +71,19 @@ export ANDROID_HOME="/opt/android-sdk"
7171
yes | sdkmanager --licenses
7272
```
7373

74-
**Step 3: Download the source code**
74+
### Step 3: Download the source code
7575

7676
To create a complete copy of the source code repository, navigate to your home directory and run:
7777
```bash
7878
git clone https://github.com/iSoron/uhabits.git
7979
```
8080
The repository will be downloaded to the directory `uhabits`.
8181

82-
**Step 4: Compile the source code**
82+
### Step 4: Compile the source code
8383

8484
1. Navigate to the directory `uhabits`
8585
2. Run `./gradlew assembleDebug --stacktrace`
8686

87-
If the compilation is successful, a debug APK will be generated somewhere inside the folder `uhabits-android/build/`. Currently, the full path is the following, but it may change in the future:
87+
If the compilation is successful, a debug APK will be generated somewhere inside the folder `uhabits-android/build/`. Currently, the full path is `./uhabits-android/build/outputs/apk/debug/uhabits-android-debug.apk`, but it may change in the future.
8888

89-
./uhabits-android/build/outputs/apk/debug/uhabits-android-debug.apk
90-
9189
The APK can be installed using the tool `adb`, which should have been automatically installed at `/opt/android-sdk/platform-tools/adb` during compilation of the project.

0 commit comments

Comments
 (0)