forks/linsk
forks/linsk
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Work on README.md

Browse source
This commit is contained in:
AlexSSD7 2023-09-03 15:10:30 +01:00
commit d7a5547128
4 changed files with 24 additions and 22 deletions
Download patch file Download diff file Expand all files Collapse all files

15
CONTRIBUTING.md Normal file
View file

@ -0,0 +1,15 @@
Thank you for showing your interest in contributing! Contributions are the most welcome. Anything including small fixes is greatly appreciated.
Please keep your new code consistent with the existing codebase and follow the industry's best practices. Before committing, please make sure that your code passes the linting & security scanning suite.
To install linting tools, execute the following commands:
```sh
make lint-deps
make security-check-deps
```
After that, you will be able to run the linter and the security scanning tool.
```sh
make lint
make security-check
```

4
INSTALL_MACOS.md
View file

@ -33,11 +33,11 @@ After that, you should be able to run `linsk`, or `~/go/bin/linsk` if you have n
## Package managers
//TODO.
TODO.
## Prebuilt binaries
//TODO.
TODO.
## Build from Source
Clone the repository using `git` and run `go build` to build the Linsk binary.

4
INSTALL_WINDOWS.md
View file

@ -40,11 +40,11 @@ After that, you should be able to run `linsk`, or `%USERPROFILE%\go\bin\linsk.ex
## Package managers
//TODO.
TODO.
## Prebuilt binaries
//TODO.
TODO.
## Build from Source
Clone the repository using `git` and run `go build` to build the Linsk binary.

23
README.md
View file

@ -26,27 +26,14 @@ Linsk relies on network file shares to expose files to the host machine. Below a
* FTP - An alternative backend.
# Installation
//TODO
- Windows: See [INSTALL_WINDOWS.md](INSTALL_WINDOWS.md).
- macOS: See [INSTALL_MACOS.md](INSTALL_MACOS.md)
- Linux (development purposes, mostly): Refer to [LINUX_DEV_ENV.md](LINUX_DEV_ENV.md).
# Contributing
//TODO: Make it a separate .md file.
Contributions are the most welcome. Anything including small fixes is greatly appreciated.
Please keep your new code consistent with the existing and follow the best practices writing Go code. Before committing, please make sure that your code passes the linting & security scanning suite.
To install linting tools, execute the following commands:
```sh
make lint-deps
make security-check-deps
```
After that, you will be able to run the linter and the security scanning tool.
```sh
make lint
make security-check
```
Please see [CONTRIBUTING.md](CONTRIBUTING.md).
# Copyright and License