From da9fd5d01661dbe2354fa78a82938c9b081e1740 Mon Sep 17 00:00:00 2001 From: Shulhan Date: Mon, 3 Feb 2025 19:41:32 +0700 Subject: README: changes Development section to describe how to setup project The previous Development section now become Links section. --- README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) (limited to 'README.md') diff --git a/README.md b/README.md index 55c0d45..dce914b 100644 --- a/README.md +++ b/README.md @@ -67,6 +67,24 @@ The "ResultsSuffix" is the one that defined in Environment. ## Development +Clone the repository and its submodule, + +``` +$ git clone https://git.sr.ht/~shulhan/gorankusu +$ git submodule update --init +``` + +Install the node tools inside the _www/ sub directory using `yarn`, + +``` +$ cd _www && yarn install +``` + +Made some changes and finally, run `make` to run lint and test the code. + + +## Links + [Repository](https://git.sr.ht/~shulhan/gorankusu):: Link to the source code. [Mailing list](https://lists.sr.ht/~shulhan/gorankusu):: Link to discussion and @@ -80,6 +98,7 @@ feature. The Gorankusu icon and image is provided by . + ## License Copyright (C) 2021 M. Shulhan -- cgit v1.3