Skip to content

Commit

Permalink
fix readme
Browse files Browse the repository at this point in the history
  • Loading branch information
leonardocustodio committed Oct 21, 2023
1 parent 18fecfd commit 2636869
Showing 1 changed file with 3 additions and 29 deletions.
32 changes: 3 additions & 29 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,35 +24,10 @@ This repo is a monorepo for `polkadart` and related packages.
| [![version][package:substrate_bip39:version]][package:substrate_bip39] | [`package:substrate_bip39`][package:substrate_bip39:source] | |
| [![version][package:substrate_metadata:version]][package:substrate_metadata] | [`package:substrate_metadata`][package:substrate_metadata:source] | |

## Requirements

You can run all tests from the library by running `docker compose up`;
Or if you have [Melos](https://melos.invertase.dev/~melos-latest/getting-started) installed globally you can run `melos test`.


```bash
brew install git-lfs
```

On Ubuntu:

```bash
sudo apt-get install git-lfs
```

## Fetching files

To ensure the `git-lfs files` are fetched inside the cloned git repository. Run these commands from the root of `polkadart repo`.

```bash
git lfs fetch
git lfs checkout
```

## Documentation and Tests

You can run all tests from the library by running `docker compose up`.
Or you can run directly in your machine using melos `dart run melos test`
You can run all tests from the library by running `docker compose up`;
Or if you have [Melos](https://melos.invertase.dev/~melos-latest/getting-started) installed globally you can run `melos test`.

## Road map and current state

Expand Down Expand Up @@ -83,7 +58,6 @@ Or you can run directly in your machine using melos `dart run melos test`

This repository is licensed under [Apache 2.0 license](https://github.com/leonardocustodio/polkadart/blob/main/LICENSE)


[package:polkadart:source]: ./packages/polkadart
[package:polkadart]: https://pub.dartlang.org/packages/polkadart
[package:polkadart:version]: https://img.shields.io/pub/v/polkadart.svg
Expand All @@ -104,4 +78,4 @@ This repository is licensed under [Apache 2.0 license](https://github.com/leonar
[package:substrate_bip39:version]: https://img.shields.io/pub/v/substrate_bip39.svg
[package:substrate_metadata:source]: ./packages/substrate_metadata
[package:substrate_metadata]: https://pub.dartlang.org/packages/substrate_metadata
[package:substrate_metadata:version]: https://img.shields.io/pub/v/substrate_metadata.svg
[package:substrate_metadata:version]: https://img.shields.io/pub/v/substrate_metadata.svg

0 comments on commit 2636869

Please sign in to comment.