cory/tildefriends
4
5
Fork 1
Code Issues 33 Pull Requests 1 Actions Releases 27 Wiki Activity

docs: misc

Browse Source
This commit is contained in:
Tasia Iso 2024-05-12 10:59:26 +02:00
parent ae3430bf56
commit 5b7d0f1aa1
Signed by: tasiaiso
SSH Key Fingerprint: SHA256:KiRjUay5C9i6objsEOIycygBHn54pDBB3Lj7fyJ0Elw
6 changed files with 26 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/apps/quickstart.md
View File

@ -47,4 +47,8 @@ TODO
TODO: tfrpc
Apps can interact with Tilde Friends using tfrpc.
Read <tfrpc.md>
TODO: sharing apps

8
docs/apps/tfrpc.md Normal file
View File

@ -0,0 +1,8 @@
# RPC documentation
Quick start
Complete documentation
TODO

2
docs/building.md
View File

@ -47,6 +47,7 @@ Now that you have a binary, head over to <running.md>.
### The compiler throws an error and I can't build the binary
You can choose to tell the compiler to ignore warnings.
Open `GNUMakefile` and edit the CFLAGS environment variable around line 50.
For example given this error:
@ -74,3 +75,4 @@ CFLAGS += \
```
Now the compiler will ignore this error and *should* continue building anyways.
This is a dirty hack to get Tilde Friends to compile and you should not propose to keep this flag on. Instead, open a bug report.

7
docs/faq.md
View File

@ -7,3 +7,10 @@ See <running.md>.
### The compiler throws an error and I can't build the binary
See <building.md>.
### Where is my database located ?
TODO

6
docs/guidelines/documentation-guidelines.md
View File

@ -1,7 +1,6 @@
# Documentation guidelines
This document defines the rules used to write documentation in order to make it more consistent.
This documentation is a living document and so are it's rules; you are free to propose changes but in the meantime, please stick to them.
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in [RFC 2119](https://www.rfc-editor.org/rfc/rfc2119/).
@ -9,7 +8,6 @@ The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "S
## File naming
Files SHOULD be named using [kebab-case](https://www.freecodecamp.org/news/snake-case-vs-camel-case-vs-pascal-case-vs-kebab-case-whats-the-difference/#kebab-case).
Their names should be meaningful and SHOULD not conflict with other files in other directories:
> 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`.
@ -49,9 +47,9 @@ The documentation should therefore be acessible and usefule to most people inter
You MAY use one line per sentence.
2. Lines ending with an `inline code block` SHOULD NOT end with a period.
2. Lines ending with an `inline code block` SHOULD NOT end with a period to make copy-pasting easier.
> Example: To build in docker, `docker build .`
> Example: To build in docker, `$ docker build .`
NB: this does not apply to file names or other text that are not meant to be copy-pasted.

2
docs/running.md
View File

@ -6,7 +6,7 @@ The binaries should appear at `out/debug/tildefriends` and `out/release/tildefri
For Android, iOS and Windows: TODO
You can now start the server by running `./out/debug/tildefriends` or `./out/release/tildefriends`.
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.