Skip to content

Commit

Permalink
Update quickstart
Browse files Browse the repository at this point in the history
  • Loading branch information
nicolaasuni committed Feb 21, 2024
1 parent 10534b4 commit 282f804
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 58 deletions.
41 changes: 12 additions & 29 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -146,43 +146,26 @@ sudo pip install --upgrade check-jsonschema


<a name="quickstart"></a>
## Quick Start
## Developers' Quick Start

This project includes a Makefile that allows you to test and build the project in a Linux-compatible system with simple commands.
All the artifacts and reports produced using this Makefile are stored in the *target* folder.
To quickly get started with this project, follow these steps:

All the packages listed in the *resources/docker/Dockerfile.dev* file are required in order to build and test all the library options in the current environment.
Alternatively, everything can be built inside a [Docker](https://www.docker.com) container using the command "make dbuild".
1. Ensure you ahev installed the latest Go version and Python3 for some extra tests.
1. Clone the repository: `git clone https://github.com/tecnickcom/rpistat.git`.
2. Change into the project directory: `cd rpistat`.
3. Install the required dependencies and test everything: `DEVMODE=LOCAL make x`.

To see all available options:
```bash
make help
```


To download all dependencies:
```bash
make deps
```
Now you are ready to start developing with rpistat!

To update the mod file:
```bash
make mod
```

To format the code (please use this command before submitting any pull request):
```bash
make format
```
This project includes a *Makefile* that allows you to test and build the project in a Linux-compatible system with simple commands.
All the artifacts and reports produced using this *Makefile* are stored in the *target* folder.

To execute all the default test builds and generate reports in the current environment:
```bash
make qa
```
Alternatively, everything can be built inside a [Docker](https://www.docker.com) container using the command `make dbuild` that uses the environment defined at `resources/docker/Dockerfile.dev`.

To build the executable file:
To see all available options:
```bash
make build
make help
```


Expand Down
41 changes: 12 additions & 29 deletions doc/src/development.tmpl
Original file line number Diff line number Diff line change
Expand Up @@ -33,43 +33,26 @@ sudo pip install --upgrade check-jsonschema


<a name="quickstart"></a>
## Quick Start
## Developers' Quick Start

This project includes a Makefile that allows you to test and build the project in a Linux-compatible system with simple commands.
All the artifacts and reports produced using this Makefile are stored in the *target* folder.
To quickly get started with this project, follow these steps:

All the packages listed in the *resources/docker/Dockerfile.dev* file are required in order to build and test all the library options in the current environment.
Alternatively, everything can be built inside a [Docker](https://www.docker.com) container using the command "make dbuild".
1. Ensure you ahev installed the latest Go version and Python3 for some extra tests.
1. Clone the repository: `git clone https://github.com/tecnickcom/rpistat.git`.
2. Change into the project directory: `cd rpistat`.
3. Install the required dependencies and test everything: `DEVMODE=LOCAL make x`.

To see all available options:
```bash
make help
```


To download all dependencies:
```bash
make deps
```
Now you are ready to start developing with rpistat!

To update the mod file:
```bash
make mod
```

To format the code (please use this command before submitting any pull request):
```bash
make format
```
This project includes a *Makefile* that allows you to test and build the project in a Linux-compatible system with simple commands.
All the artifacts and reports produced using this *Makefile* are stored in the *target* folder.

To execute all the default test builds and generate reports in the current environment:
```bash
make qa
```
Alternatively, everything can be built inside a [Docker](https://www.docker.com) container using the command `make dbuild` that uses the environment defined at `resources/docker/Dockerfile.dev`.

To build the executable file:
To see all available options:
```bash
make build
make help
```


Expand Down

0 comments on commit 282f804

Please sign in to comment.