Compare commits

..

No commits in common. "1b3b9e570e8871488f3deab7bac9f1f059ef4ebb" and "43f6a3a482d4b335370d0658367f12ef053396f6" have entirely different histories.

16 changed files with 18 additions and 34 deletions

View File

@ -1,3 +0,0 @@
---
name: 'Bug Report'
---

View File

@ -1,5 +0,0 @@
blank_issues_enabled: true
contact_links:
- name: Documentation
url: https://dev.tildefriends.net/cory/tildefriends/src/branch/main/docs/index.md
about: Read the documentation

View File

@ -1,3 +0,0 @@
---
name: 'Feature Request'
---

View File

@ -1,9 +0,0 @@
To Do List
- [ ] My changes are documented in the [documentation](https://dev.tildefriends.net/cory/tildefriends/src/branch/main/docs/index.md)
- [ ] I have tested my changes
- [ ] I agree to the contribution guidelines
- [ ] [C](https://dev.tildefriends.net/cory/tildefriends/src/branch/main/docs/guidelines/c-guidelines.md)
- [ ] [JavaScript](https://dev.tildefriends.net/cory/tildefriends/src/branch/main/docs/guidelines/javascript-guidelines.md)
- [ ] [documentation](https://dev.tildefriends.net/cory/tildefriends/src/branch/main/docs/guidelines/documentation-guidelines.md)
<!-- - [ ] I agree to the [Code of Conduct]() -->

1
.gitignore vendored
View File

@ -8,5 +8,4 @@ out
*.swo
*.swp
.zsign_cache/
result
NOTES.md

View File

@ -14,7 +14,7 @@ It is both a peer-to-peer social network client, participating in Secure Scuttle
## Documentation
Docs are a work in progress: [documentation](https://dev.tildefriends.net/cory/tildefriends/src/branch/main/docs/index.md), or alternatively in Tilde Friends: <https://www.tildefriends.net/~cory/wiki/#test-wiki/tf-app-quick-reference>.
Docs are a work in progress in the `docs` folder, or alternatively in Tilde Friends: <https://www.tildefriends.net/~cory/wiki/#test-wiki/tf-app-quick-reference>.
## License

View File

@ -32,6 +32,7 @@ main();
Save the app, and you should now be seeing `Hello world!` on the screen.
## Components
Once your app grows to a certain size, you'll want to introduce components.
@ -48,6 +49,6 @@ TODO: tfrpc
Apps can interact with Tilde Friends using tfrpc.
Read [tfrpc.md](https://dev.tildefriends.net/cory/tildefriends/src/branch/main/docs/apps/tfrpc.md)
Read <tfrpc.md>
TODO: sharing apps

View File

@ -4,4 +4,5 @@ Quick start
Complete documentation
TODO

View File

@ -41,7 +41,7 @@ To build in docker, `docker build .`
<!-- On NixOS: TODO -->
<!-- Add shell.nix and nix derivs first -->
Now that you have a binary, head over to [running.md](https://dev.tildefriends.net/cory/tildefriends/src/branch/main/docs/running.md).
Now that you have a binary, head over to <running.md>.
## Troubleshooting

View File

@ -38,7 +38,7 @@ TODO
- I want to write documentation !
Great! Before you do, have a look at the [documentation guidelines](https://dev.tildefriends.net/cory/tildefriends/src/branch/main/docs/guidelines/documentation-guidelines.md) to learn how to write consistent documentation.
Great! Before you do, have a look at the [documentation guidelines](guidelines/documentation-guidelines.md) to learn how to write consistent documentation.
In all cases:

View File

@ -2,12 +2,12 @@
## Building
See [building.md](https://dev.tildefriends.net/cory/tildefriends/src/branch/main/docs/building.md).
See <building.md>.
## Contibuting
See [contributing.md](https://dev.tildefriends.net/cory/tildefriends/src/branch/main/docs/contributing.md).
See <contributing.md>.
## FAQ / Troubleshooting
See [faq.md](https://dev.tildefriends.net/cory/tildefriends/src/branch/main/docs/faq.md).
See <faq.md>.

View File

@ -2,12 +2,15 @@
## I started tildefriends. Now what ?
See [running.md](https://dev.tildefriends.net/cory/tildefriends/src/branch/main/docs/running.md).
See <running.md>.
### The compiler throws an error and I can't build the binary
See [building.md](https://dev.tildefriends.net/cory/tildefriends/src/branch/main/docs/building.md).
See <building.md>.
### Where is my database located ?
TODO

View File

@ -1 +1 @@
# TODO
TODO

View File

@ -1 +1 @@
# TODO
TODO