aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorJesús <heckyel@hyperbola.info>2021-12-01 22:45:05 -0500
committerJesús <heckyel@hyperbola.info>2021-12-01 22:45:05 -0500
commit0ef5a8fe632e568c1b80572ae23e46c61f2da185 (patch)
tree352d7273796b975227eca82f34857be71abf9052 /README.md
downloadcountries-0ef5a8fe632e568c1b80572ae23e46c61f2da185.tar.lz
countries-0ef5a8fe632e568c1b80572ae23e46c61f2da185.tar.xz
countries-0ef5a8fe632e568c1b80572ae23e46c61f2da185.zip
initial public
Diffstat (limited to 'README.md')
-rw-r--r--README.md48
1 files changed, 48 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..02b48b8
--- /dev/null
+++ b/README.md
@@ -0,0 +1,48 @@
+# Countries
+
+Theme built CSS and JavaScript
+
+## Usage
+
+```console
+$ cp -v .env.example .env
+```
+
+```console
+$ make serve
+```
+
+## Installation
+
+Orginal Repo:
+
+```console
+$ git clone https://hgit.conocimientoslibres.ga/testing/countries.git
+
+```
+
+Mirror Repo:
+
+```console
+$ git clone https://notabug.org/heckyel/countries.git
+```
+
+## Build It
+
+First, you need to compile the theme using [SassC](https://github.com/sass/sassc) compiler amd
+[Python](https://www.python.org/) as local-server.
+
+Then install `sassc` for example:
+
+```console
+# pacman -S sassc
+```
+
+You see Makefile:
+
+```console
+$ make all
+```
+
+## License
+This work is under the License [GNU AGPLv3 +](LICENSE.md)