Skip to content

Commit

Permalink
Modified Readme
Browse files Browse the repository at this point in the history
Added a 'markdownlint' package to lint locally the README.md

fixed README.md according its rules
  • Loading branch information
qlrd committed Sep 16, 2023
1 parent 811fc0e commit 9cf13e6
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 9 deletions.
17 changes: 9 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,9 @@ For more information, see [flash the firmware onto the device](https://selfcusto

## Install

- See [releases page](https://github.com/selfcustody/krux-installer/releases); or
- See [releases page](https://github.com/selfcustody/krux-installer/releases);
or

- [Build from source](/#build-from-source)

## Build from source
Expand Down Expand Up @@ -125,18 +127,18 @@ to setup the build `target` on specific `os` (Operational System).
The `<target>` depends depends on the running platform
(i.e., `linux`, `darwin` -- MacOS, and `win32` -- Windows).

For more information, see
[Electron Builder configuration](https://www.electron.build/configuration/configuration)
For more information,
see [Electron Builder](https://www.electron.build/configuration/configuration)
page.

#### Run all tests:
#### Run all tests

The `wdio.conf.mts` is configured to check
if your system have `krux.zip.*` resources.

- If not, it will, run all tests, including download tests;
- If yes, it will skip tests that download resources.


```bash
yarn run build
```
Expand All @@ -153,7 +155,6 @@ If you want to debug some messages, add the

In linux/mac:


```bash
DEBUG=krux:* yarn run build --<os> <target>
```
Expand All @@ -172,7 +173,6 @@ yarn run e2e --filter '0([0-1][0-9]|2[0-4]).*.spec.ts'

if you want to debug some messages:


```bash
DEBUG=krux:* yarn run e2e --filter '0([0-1][0-9]|2[0-4]).*.spec.ts'
```
Expand All @@ -198,6 +198,7 @@ The compilation process is done entirely in a reproducible virtual environment a
therefore, not locally, with the github-action [compile-openssl-windows-action](https://github.com/qlrd/compile-openssl-windows-action/actions).

Since it is compiled in a virtual environment on github:

- it is expected to be fully verifiable and free of malicious code;
- it is expected that, if you're developing in Windows machine,
some difficulties will be appear.
Expand Down Expand Up @@ -235,4 +236,4 @@ some difficulties will be appear.
- MacOS:
- [x] Build DMG installer;
- [ ] Build PKG installer;
- [ ] Build MAS installer;
- [ ] Build MAS installer;
4 changes: 3 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,8 @@
"dev": "vue-tsc --noEmit && vite",
"build": "vue-tsc --noEmit && vite build && electron-builder",
"preview": "vite preview",
"e2e": "wdio run wdio.conf.mts"
"e2e": "wdio run wdio.conf.mts",
"lint:md": "markdownlint README.md --ignore node_modules"
},
"devDependencies": {
"@babel/cli": "^7.22.9",
Expand All @@ -56,6 +57,7 @@
"electron": "^26.0.0",
"electron-builder": "^24.4.0",
"glob": "^10.3.3",
"markdownlint-cli": "^0.36.0",
"mocha": "^10.2.0",
"os-lang": "^3.1.1",
"rimraf": "^5.0.1",
Expand Down

0 comments on commit 9cf13e6

Please sign in to comment.