aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorShulhan <ms@kilabit.info>2025-02-03 19:41:32 +0700
committerShulhan <ms@kilabit.info>2025-02-03 20:11:24 +0700
commitda9fd5d01661dbe2354fa78a82938c9b081e1740 (patch)
treefb761fdb57f7a14d5da40628584fda7d3de737a4 /README.md
parent2e26d5517f8865aea7f6f7f1e3e7e9c6c89f0b4c (diff)
downloadgorankusu-da9fd5d01661dbe2354fa78a82938c9b081e1740.tar.xz
README: changes Development section to describe how to setup project
The previous Development section now become Links section.
Diffstat (limited to 'README.md')
-rw-r--r--README.md19
1 files changed, 19 insertions, 0 deletions
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 <https://www.spriters-resource.com/>.
+
## License
Copyright (C) 2021 M. Shulhan <ms@kilabit.info>