Skip to content

Commit

Permalink
docs: update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
AladdineDev committed Feb 7, 2024
1 parent 69714fa commit 0d42b62
Showing 1 changed file with 8 additions and 12 deletions.
20 changes: 8 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,33 +25,29 @@ Flutter Portfolio – by [@AladdineDev](https://github.com/AladdineDev)

If you haven't already, install [Flutter](https://docs.flutter.dev/get-started/install)

**1. Clone the repository and set your remote URL**
[Fork](https://github.com/AladdineDev/portfolio/fork) and [clone](https://docs.github.com/en/get-started/quickstart/fork-a-repo#cloning-your-forked-repository) this repository

```bash
$ git clone https://github.com/AladdineDev/portfolio
$ cd portfolio
$ git remote set-url origin https://github.com/<YOUR_USERNAME>/<YOUR_REPOSITORY>
```
| Enable your workflows to allow deployment |
| -----------------------------------------------|
| ![](./docs/images/github-actions-enable-workflows.png)|

> From here, you're all set to [deploy](#deploy) your portfolio online. To build it locally and customize it, continue with the instructions below.
From here, you're all set to [deploy](#deploy) your portfolio online. To build it locally and make customizations, follow the instructions below.

**2. Install dependencies:**
**1. Install dependencies:**

```bash
$ flutter pub get
```

### Generator 🤖

**1. Run the code generator:**
**2. Run the code generator:**

```bash
$ dart run build_runner build -d
```

> For additional information, refer to the [build_runner](https://pub.dev/packages/build_runner) documentation
<a id="generate-localization-files" style="text-decoration:none">**2. Generate localization files:**</a>
<a id="generate-localization-files" style="text-decoration:none">**3. Generate localization files:**</a>

```bash
$ dart run easy_localization:generate -S assets/translations -f json -O lib/src/localization/generated -o locale_json.g.dart
Expand Down

0 comments on commit 0d42b62

Please sign in to comment.