docs: guideline 3
This commit is contained in:
		| @@ -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 | ||||
|  | ||||
|   | ||||
| @@ -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 | ||||
|   | ||||
| @@ -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 <http://localhost:12345/>. `tildefriends -h` lists further options. | ||||
| at <http://localhost:12345/>. `$ tildefriends -h` lists further options. | ||||
|  | ||||
| ## How to use TF | ||||
|  | ||||
|   | ||||
		Reference in New Issue
	
	Block a user