From 7d77e398d47ca0f7052600921833b2d167062861 Mon Sep 17 00:00:00 2001 From: Tasia Iso Date: Sun, 12 May 2024 10:57:39 +0200 Subject: [PATCH] docs: guideline 3 --- docs/contributing.md | 6 +++--- docs/guidelines/documentation-guidelines.md | 7 +++++++ docs/running.md | 2 +- 3 files changed, 11 insertions(+), 4 deletions(-) diff --git a/docs/contributing.md b/docs/contributing.md index 93eba35b..bd4e0592 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -6,15 +6,15 @@ 1. Alternatively, you can add a remote called `fork`: - `git remote add fork https://dev.tildefriends.net/YOUR_USERNAME/tildefriends.git` + `$ git remote add fork https://dev.tildefriends.net/YOUR_USERNAME/tildefriends.git` You'll need to set your branch's upstream to `fork`: - `git push --set-upstream fork my-branch` + `$ git push --set-upstream fork my-branch` 2. or you can change the `origin` remote on your existing clone altogether: - `git remote set-url origin https://dev.tildefriends.net/YOUR_USERNAME/tildefriends.git` + `$ git remote set-url origin https://dev.tildefriends.net/YOUR_USERNAME/tildefriends.git` - Make your changes diff --git a/docs/guidelines/documentation-guidelines.md b/docs/guidelines/documentation-guidelines.md index 6c84386a..d2391201 100644 --- a/docs/guidelines/documentation-guidelines.md +++ b/docs/guidelines/documentation-guidelines.md @@ -57,6 +57,13 @@ NB: this does not apply to file names or other text that are not meant to be cop > Example: this document is named `docs/guidelines/documentation-guidelines.md` instead of `docs/guidelines/documentation.md` because it could cause confusion with `docs/documentation.md`. +3. Commands SHOULD start with a caret: (is that the tehnical term ?) + + - `$` if the command should be run as the current user + - `#` if the command should be run as root + + > Example: To build in docker, `$ docker build .` + More TODO ## License diff --git a/docs/running.md b/docs/running.md index 69e11447..6a0443d1 100644 --- a/docs/running.md +++ b/docs/running.md @@ -9,7 +9,7 @@ For Android, iOS and Windows: TODO You can now start the server by running `./out/debug/tildefriends` or `./out/release/tildefriends`. By default, running the built `tildefriends` executable will start a web server -at . `tildefriends -h` lists further options. +at . `$ tildefriends -h` lists further options. ## How to use TF