Alexander/FitTrackee
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

update documentation

Browse Source
This commit is contained in:
Sam 2022-03-26 16:06:46 +01:00
parent 1074272ac0
commit 8e8c25bce9
2 changed files with 6 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
CONTRIBUTING.md
View File

@ -20,8 +20,6 @@ The **GitHub** repository contains:
- tests,
- documentation (source and build).
Continuous integration pipeline runs on **Gitlab CI**.
### How to install FitTrackee
see [Installations instructions](https://samr1.github.io/FitTrackee/installation.html)
@ -54,12 +52,10 @@ Please make your changes from the development branch (`dev`).
```shell
$ make check-all
```
There are some end-to-end tests, to run them:
There are some end-to-end tests, to run them (needs a running application):
```shell
$ make test-e2e
```
Note: For now, pull requests from forks don't trigger pipelines on GitLab CI (see [current issue](https://gitlab.com/gitlab-org/gitlab/-/issues/5667)).
So make sure that checks don't return errors locally.
* If needed, add or update tests.
@ -74,5 +70,7 @@ Please make your changes from the development branch (`dev`).
* Ensure the pull requests description clearly describes the problem and solution. Include the relevant issue number if applicable.
* If needed, [update your branch](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/keeping-your-pull-request-in-sync-with-the-base-branch).
Thanks.

11
README.md
View File

@ -9,9 +9,9 @@
[![Vue Version](https://img.shields.io/badge/vue-3.2-brightgreen.svg)](https://v3.vuejs.org/)
[![Typescript Version](https://img.shields.io/npm/types/typescript)](https://www.typescriptlang.org/)
[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://github.com/prettier/prettier)
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/290a285f22e94132904dc13b4dd19d1d)](https://www.codacy.com/app/SamR1/FitTrackee)
[![pipeline status](https://gitlab.com/SamR1/FitTrackee/badges/master/pipeline.svg)](https://gitlab.com/SamR1/FitTrackee/-/commits/master)
[![coverage report](https://gitlab.com/SamR1/FitTrackee/badges/master/coverage.svg)](https://gitlab.com/SamR1/FitTrackee/-/commits/master) <sup><sup>1</sup></sup>
![pipeline status](https://github.com/SamR1/FitTrackee/actions/workflows/.tests-python.yml/badge.svg?branch=master)
![pipeline status](https://github.com/SamR1/FitTrackee/actions/workflows/.tests-javascript.yml/badge.svg?branch=master)
---
@ -30,8 +30,3 @@ It is also possible to add a workout without a gpx file.
(see [issues](https://github.com/SamR1/FitTrackee/issues) and [documentation](https://samr1.github.io/FitTrackee) for more information)
![FitTrackee Dashboard Screenshot](https://samr1.github.io/FitTrackee/_images/fittrackee_screenshot-01.png)
---
Notes:
_1. Test coverage: only for Python API_