Skip to content

Commit 0b84adc

Browse files
committed
docs: update README for mise and fix contributors badge (#255)
- Integrate mise setup into "Get started" section, replacing separate FVM section - Streamline development setup flow: mise → clone → mise install → flutter doctor → pub get - Replace broken all-contributors badge with GitHub contributors badge - Update copyright year to 2026
1 parent 1784f95 commit 0b84adc

1 file changed

Lines changed: 17 additions & 26 deletions

File tree

README.md

Lines changed: 17 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -99,28 +99,34 @@ unexpected errors.
9999

100100
Due to the strong drive of [Flutter](https://flutter.dev/), the development of TAT is accomplished with half the effort.
101101

102-
- First, it is recommended that you install Flutter in your development environment. If you are not yet familiar with
103-
Flutter, you may refer to its official website for tutorials.
102+
- First, install [mise](https://mise.jdx.dev/) by following the
103+
[instructions](https://mise.jdx.dev/getting-started.html). This project uses mise to manage tool versions (Flutter,
104+
Java, and Ruby).
104105

105-
- Next, you are required to install [Android Studio](https://developer.android.com/studio) or
106+
- Next, install [Android Studio](https://developer.android.com/studio) or
106107
[VSCode](https://code.visualstudio.com/) in your development environment, as Flutter and Dart officially recommend the
107108
use of these two solutions for development. However, if you believe that other editors/IDEs are a better choice for
108109
you, you may try installing them as well.
109110

110-
- Once your editor/IDE is set up, it is advisable to run Flutter Doctor to check for any missing steps.
111+
- Clone the code of TAT to your environment through [Git](https://git-scm.com/).
111112

112113
```bash
113-
# Make sure you are using the latest Stable version of Flutter and Dart.
114-
flutter doctor -v
114+
git clone --recurse-submodules git@github.com:NEO-TAT/tat_flutter.git
115115
```
116116

117-
- Now, you may clone the code of TAT to your environment through [Git](https://git-scm.com/).
117+
- Install all required tools specified in `mise.toml`.
118118

119119
```bash
120-
git clone --recurse-submodules git@github.com:NEO-TAT/tat_flutter.git
120+
mise install
121+
```
122+
123+
- Verify that Flutter is correctly installed.
124+
125+
```bash
126+
flutter doctor -v
121127
```
122128

123-
- Then, start installing the dependencies in the TAT project.
129+
- Install the dependencies in the TAT project.
124130

125131
```bash
126132
flutter pub get
@@ -134,14 +140,6 @@ Once all dependencies are successfully installed (excluding `tat_core`), you can
134140
> Otherwise, you will not be able to build successfully. For information on how to join the **NPC**, please refer to the
135141
> Contact Us section below.
136142
137-
## Using FVM to Install Flutter
138-
139-
To set up FVM and Flutter 3.7.12 (our last supported version):
140-
141-
1. Follow the [instructions](https://fvm.app/documentation/getting-started/installation) to install FVM.
142-
1. Run `fvm use` in the project directory to install the Flutter version specified in `.fvmrc`.
143-
1. Use `fvm flutter --version` to verify that Flutter is correctly installed.
144-
145143
If you have any questions during the above steps, please feel free to contact us (NPC) anytime.
146144

147145
## Discussion
@@ -197,13 +195,6 @@ Furthermore, we have compiled detailed development materials into our
197195

198196
## Contributors
199197

200-
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
201-
<!-- prettier-ignore-start -->
202-
<!-- markdownlint-disable -->
203-
[![All Contributors](https://img.shields.io/github/all-contributors/NEO-TAT/tat_flutter?color=ee8449&style=flat-square)](#contributors)
204-
<!-- markdownlint-restore -->
205-
<!-- prettier-ignore-end -->
206-
207-
<!-- ALL-CONTRIBUTORS-LIST:END -->
198+
[![Contributors](https://img.shields.io/github/contributors/NEO-TAT/tat_flutter?color=ee8449&style=flat-square)](https://github.com/NEO-TAT/tat_flutter/graphs/contributors)
208199

209-
_Copyright © 2023 All rights reserved and owned by [**N.P.C. 北科程式設計研究社**](https://ntut.club)._
200+
_Copyright © 2026 All rights reserved and owned by [**N.P.C. 北科程式設計研究社**](https://ntut.club)._

0 commit comments

Comments
 (0)