tilde.chat/wiki/README.md

53 lines
1.3 KiB
Markdown
Raw Normal View History

2018-08-30 05:40:29 +00:00
# tilde.chat wiki
hi there, welcome to our wiki!
to contribute to the wiki:
2018-10-15 22:29:34 +00:00
* [fork the repo](https://tildegit.org/repo/fork/53)
2018-08-30 05:40:29 +00:00
* clone the repo to your local machine (or your public_html folder on the tilde.team box for live testing)
```sh
2020-05-09 21:00:14 +00:00
git clone git@tildegit.org:tildeverse/tilde.chat
2020-05-15 20:30:52 +00:00
cd tilde.chat
2018-08-30 05:40:29 +00:00
```
* create a new branch for your page
```sh
git checkout -b my-new-page
```
* if you want to add a new page, copy `template.md` into your new page!
```sh
2020-05-15 20:30:52 +00:00
cp wiki/template.md wiki/my-new-page.md
2018-08-30 05:40:29 +00:00
```
2020-05-15 20:30:52 +00:00
* test your changes locally
```sh
composer install
php -S localhost:9000
```
this will run your site at http://localhost:9000/
if you are running the development server on your tilde account, you
will not be able to access it on (hostname):9000 because it only runs
on localhost, but you can create a tunnel with
ssh -L 9000:localhost:9000
to access from your localhost:9000 address
2020-05-15 20:30:52 +00:00
2018-08-30 05:40:29 +00:00
* edit as needed!
2018-10-15 22:29:34 +00:00
* commit your changes and [create a pull request](https://tildegit.org/tildeverse/tilde.chat/pulls) :)
2018-08-30 05:40:29 +00:00
```sh
git add --all
git commit -m "added my-new-page"
git push origin my-new-page # this should match the branch name you created earlier
```
2018-10-15 22:29:34 +00:00
* create a pull request on the [site](https://tildegit.org/tildeverse/tilde.chat) repo
2018-08-30 05:40:29 +00:00
thanks!~
2020-05-09 21:00:14 +00:00
ps. if you have any questions, ask on irc! (try #helpdesk or #meta)