From a50e800a919956b744a9c994151e33aed2a21b7c Mon Sep 17 00:00:00 2001 From: lostinlight Date: Tue, 4 Aug 2020 01:30:53 +0300 Subject: [PATCH] Update README, CONTRIBUTING links --- CONTRIBUTING.md | 6 ++++-- README.md | 6 +++++- 2 files changed, 9 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8b83f74..8c85815 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,7 +1,9 @@ # CONTRIBUTING -Don't hesitate to send a merge request. +Don't hesitate to send a merge request or to open an issue. + +Also, check out our [Wiki pages](https://git.feneas.org/feneas/fediverse/-/wikis/home) ### [Submitting software](#submitting-software) @@ -28,7 +30,7 @@ Please, choose no more than **2 categories** (array of strings) for the software * `Ev-Meet` (events, meetups, calendars) * `Files` (file hosting software) * `Econ` (economic activities) -* `DataForge` (dataset / corpora exchange) +* `Open data` (dataset / corpora exchange) * `Reviews` (networks whose main purpose is reviewing stuff) * `Games` (gaming servers and apps) diff --git a/README.md b/README.md index c0732d4..2913b97 100644 --- a/README.md +++ b/README.md @@ -15,6 +15,8 @@ Read [Contributing](./CONTRIBUTING.md) +→ Check out [our Wiki](https://git.feneas.org/feneas/fediverse/-/wikis/home) ← + ### [Structure](#structure) #### Fediverse page @@ -44,6 +46,8 @@ Supposed to link to a page helping to choose a server on any network (just an id ### [Setup](#setup) +This site uses [Hexo](https://hexo.io) static generator. Follow these steps to spin up a local development environment: + 1. Run `npm install` in main project's folder 2. Run `gulp` in `/themes/starter` folder 3. In second terminal, run `hexo server` in main folder, to start the server and preview at localhost @@ -51,7 +55,7 @@ Supposed to link to a page helping to choose a server on any network (just an id ### [Translating](#translating) -Maintaining several website translations will require extra work. Please, read [discussion](https://gitlab.com/fediverse/fediverse.gitlab.io/issues/9). +Maintaining several website translations will require extra work. Please, read [discussion](https://git.feneas.org/feneas/fediverse/-/issues/2). Adding another language requires additions to `_config` file and `/themes/starter/languages` folder. Mandatory for translating: