From d7a5547128df4a783b84ccf9b52b6a7645bedf67 Mon Sep 17 00:00:00 2001 From: AlexSSD7 Date: Sun, 3 Sep 2023 15:10:30 +0100 Subject: [PATCH] Work on README.md --- CONTRIBUTING.md | 15 +++++++++++++++ INSTALL_MACOS.md | 4 ++-- INSTALL_WINDOWS.md | 4 ++-- README.md | 23 +++++------------------ 4 files changed, 24 insertions(+), 22 deletions(-) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..9b96ed3 --- /dev/null +++ b/CONTRIBUTING.md @@ -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 +``` \ No newline at end of file diff --git a/INSTALL_MACOS.md b/INSTALL_MACOS.md index a207a89..3fe305d 100644 --- a/INSTALL_MACOS.md +++ b/INSTALL_MACOS.md @@ -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. diff --git a/INSTALL_WINDOWS.md b/INSTALL_WINDOWS.md index 100ee6b..21bc18c 100644 --- a/INSTALL_WINDOWS.md +++ b/INSTALL_WINDOWS.md @@ -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. diff --git a/README.md b/README.md index 60a33c1..5122575 100644 --- a/README.md +++ b/README.md @@ -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